Help Center> Organizations> API Reference> API> Managing Accounts> Getting Account Information

Updated on 2024-03-15 GMT+08:00

View PDF

Getting Account Information

Function

This API is used to get the information about the specified account. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

URI

GET /v1/organizations/accounts/{account_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
account_id	Yes	String	Unique ID of an account. Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Minimum: 1

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
account	AccountDto object	Information about the member accounts in an organization.

**Table 4** AccountDto
Parameter	Type	Description
id	String	Unique ID of an account. Maximum: 36
urn	String	Uniform resource name of the account. Minimum: 1 Maximum: 1500
join_method	String	How an account joined an organization. Minimum: 1 Maximum: 64
status	String	Account status. It can be ACTIVE, SUSPENDED, or PENDING_CLOSURE. Minimum: 1 Maximum: 64
joined_at	String	Date when an account joined an organization.
name	String	Account name. Maximum: 64

Example Requests

Getting Account Information

GET https://{hostname}/v1/organizations/accounts/{account_id}

Example Responses

Status code: 200

Successful.

{
  "account" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331"
  }
}