IsMemberInGroups - Identity Store


Checks the user's membership in all requested groups and returns if the member exists in all queried groups.


If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the AWS Organizations User Guide.

Request Syntax

{ "GroupIds": [ "string" ], "IdentityStoreId": "string", "MemberId": { ... } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


A list of identifiers for groups in the identity store.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 47.

Pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

Required: Yes


The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes


An object containing the identifier of a group member.

Type: MemberId object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax

{ "Results": [ { "GroupId": "string", "MemberId": { ... }, "MembershipExists": boolean } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A list containing the results of membership existence checks.

Type: Array of GroupMembershipExistenceResult objects


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 400


The request processing has failed because of an unknown error, exception or failure with an internal server.

HTTP Status Code: 500


Indicates that a requested resource is not found.

HTTP Status Code: 400


Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400


The request failed because it contains a syntax error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: