Skip to content

Describe Group Membership

identitystore_describe_group_membership R Documentation

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.

MembershipId

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

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  MembershipId = "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"
)