Skip to content

Retrieves membership metadata and attributes from MembershipId in an identity store

Description

Retrieves membership metadata and attributes from 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_describe_group_membership(IdentityStoreId, MembershipId)

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.

  • MembershipId

    [required] The identifier for a GroupMembership in an identity store.

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

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  MembershipId = "string",
  MembershipArn = "string",
  GroupId = "string",
  MemberId = list(
    UserId = "string"
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = "string",
  UpdatedBy = "string"
)

Request syntax

svc$describe_group_membership(
  IdentityStoreId = "string",
  MembershipId = "string"
)