IdentityStore / Client / get_group_membership_id

get_group_membership_id

IdentityStore.Client.get_group_membership_id(**kwargs)

Retrieves the MembershipId in an identity store.

Note

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_group_membership_id(
    IdentityStoreId='string',
    GroupId='string',
    MemberId={
        'UserId': 'string'
    }
)
Parameters:

  • IdentityStoreId (string) –

    [REQUIRED]

    The globally unique identifier for the identity store.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

  • GroupId (string) –

    [REQUIRED]

    The identifier for a group in the identity store.

    You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

  • MemberId (dict) –

    [REQUIRED]

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: UserId.

    • UserId (string) –

      The identifier for a user in the identity store.

      You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'MembershipId': 'string',
    'MembershipArn': 'string'
}

Response Structure

  • (dict) –

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

    • MembershipId (string) –

      The identifier for a GroupMembership in an identity store.

    • MembershipArn (string) –

      The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.

Exceptions