Skip to content

Retrieves the MembershipId in an identity store

Description

Retrieves the MembershipId in an identity store.

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.

Usage

identitystore_get_group_membership_id(IdentityStoreId, GroupId,
  MemberId)

Arguments

  • IdentityStoreId

    [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

    [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

    [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.

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  MembershipId = "string",
  MembershipArn = "string"
)

Request syntax

svc$get_group_membership_id(
  IdentityStoreId = "string",
  GroupId = "string",
  MemberId = list(
    UserId = "string"
  )
)