OPoptum

Get accounts

Changed on
get/accounts

Request

Query parameters

idstring

Account ID.

statusstring

Status of the account.

adminRoleArnstring

The Admin Role ARN for the account.

principalRoleArnstring

The Principal Role ARN for the account.

principalPolicyHashstring

The Principal Policy version for the account.

nextIdstring

Account ID with which to begin the scan operation. This is used to traverse through paginated results.

limitinteger

The maximum number of accounts to evaluate (not necessarily the number of matching accounts). If there is another page, the URL for page will be in the response Link header.

Response

OK

idstring

AWS Account ID

accountStatus'Ready' | 'NotReady' | 'Leased' | 'Orphaned'

Status of the Account. "Ready": The account is clean and ready for lease "NotReady": The account is in "dirty" state, and needs to be reset before it may be leased. "Leased": The account is leased to a principal

adminRoleArnstring

ARN for an IAM role within this AWS account. The DCE master account will assume this IAM role to execute operations within this AWS account. This IAM role is configured by the client, and must be configured with a Trust Relationship with the DCE master account.

principalRoleArnstring

ARN for an IAM role within this AWS account. This role is created by the DCE master account, and may be assumed by principals to login to their AWS child account.

principalPolicyHashstring

The S3 object ETag used to apply the Principal IAM Policy within this AWS account. This policy is created by the DCE master account, and is assumed by people with access to principalRoleArn.

lastModifiedOninteger

Epoch timestamp, when account record was last modified

createdOninteger

Epoch timestamp, when account record was created

metadataobject

Any organization specific data pertaining to the account that needs to be persisted

Changes

  • 11d73002ea62Revision changes
    • info

      added the new optional query request parameter adminRoleArn

    • info

      added the new optional query request parameter principalPolicyHash

    • info

      added the new optional query request parameter principalRoleArn

  • d532a85f38efRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter nextId

    • info

      added the new optional query request parameter status