Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424171133.3 KB

Returns the attributes of a membership.

get/v1/membership/{membershipId}

Path parameters

membershipIdstring required

Required element for GetMembership to identify the membership ID to query.

Response

Success

membershipIdstring required

Response element for GetMembership that provides the queried membership ID.

accountIdstring

Response element for GetMembership that provides the account configured to manage the membership.

region'af-south-1' | 'ap-east-1' | 'ap-east-2' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-south-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-southeast-3' | 'ap-southeast-4' | 'ap-southeast-5' | 'ap-southeast-6' | 'ap-southeast-7' | 'ca-central-1' | 'ca-west-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-south-1' | 'eu-south-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'il-central-1' | 'me-central-1' | 'me-south-1' | 'mx-central-1' | 'sa-east-1' | 'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2'

Response element for GetMembership that provides the region configured to manage the membership.

membershipNamestring password

Response element for GetMembership that provides the configured membership name.

membershipArnstring

Response element for GetMembership that provides the membership ARN.

membershipStatus'Active' | 'Cancelled' | 'Terminated'

Response element for GetMembership that provides the current membership status.

membershipActivationTimestampstring date-time

Response element for GetMembership that provides the configured membership activation timestamp.

membershipDeactivationTimestampstring date-time

Response element for GetMembership that provides the configured membership name deactivation timestamp.

customerType'Standalone' | 'Organization'

Response element for GetMembership that provides the configured membership type. Options include <code> Standalone | Organizations</code>.

numberOfAccountsCoveredinteger

Response element for GetMembership that provides the number of accounts in the membership.