Obtaining the Identity Information of a Caller

Function

This API is used to obtain the identity information of a caller (such as a user or agency).

Authorization Information

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

URI

GET /v5/caller-identity

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition: security_token field of a temporary security credential. Constraints: When an API is called using a temporary security credential, the HTTP header X-Security-Token must be provided. Range: N/A Default Value: N/A

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
account_id	String	Definition: Account ID. Range: N/A
principal_urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
principal_id	String	Definition: Principal ID. Range: N/A

Status code: 500

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is STS5.XXXX, for example, STS5.1001.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.

Example Requests

Obtaining the identity information of a caller

GET https://{endpoint}/v5/caller-identity

Example Responses

Status code: 200

Successful

{
  "account_id" : "27680d67da6b47eb82d00a1a118be145",
  "principal_urn" : "iam::27680d67da6b47eb82d00a1a118be145:user:user-name",
  "principal_id" : "user-id"
}