Updated on 2026-09-23 GMT+08:00

Obtaining All Service Principals

Function

This API is used to obtain all service principals.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /v5/service-principals

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Number of records displayed per page. Constraints: N/A Range: The value ranges from 1 to 200. Default Value: The default value is 100.
marker	No	String	Definition Pagination marker automatically generated by the service to mark the start position of this request. The value can be obtained from next_marker in the response body of the previous pagination request. Constraints N/A Range The value contains 4 to 400 characters, including only letters, digits, and the following special characters: +/=-_ Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Definition: Language of the returned results. Constraints: N/A Range: Chinese ("zh-cn") or English ("en-us"). Default Value: The default value is zh-cn.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
service_principals	Array of service_principals objects	Definition: List of service principals. Range: N/A
page_info	page_info object	Definition: Pagination information. Range: N/A

**Table 4** service_principals
Parameter	Type	Description
service_principal	String	Definition: Service principal Range: N/A
service_catalog	String	Definition: Cloud service name. Range: N/A
display_name	String	Definition: Service principal name for display. Range: N/A
description	String	Definition Service principal description. Range The value contains 0 to 255 characters and must comply with the regular expression ^[^@#%&<>\$^]$.

**Table 5** page_info
Parameter	Type	Description
next_marker	String	Definition: Start position marker for the next pagination invoking, which is automatically generated by the service. Range: N/A
current_count	Integer	Definition: Number of records returned on this page. Range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Example Requests

Obtaining all service principals

GET https://{endpoint}/v5/service-principals

Example Responses

Status code: 200

{
  "service_principals" : [ {
    "service_principal" : "service.xxx",
    "service_catalog" : "XXX",
    "display_name" : "display_name",
    "description" : "description"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}

Status Codes

Status Code	Description
200	Successful
400	Bad request

Error Codes

See Error Codes.

Parent topic: Querying the Authorization Summary