Skip to content

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

Description

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

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_is_member_in_groups(IdentityStoreId, MemberId, GroupIds)

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.

  • MemberId

    [required] An object containing the identifier of a group member.

  • GroupIds

    [required] A list of identifiers for groups in the identity store.

    You can specify each 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.

Value

A list with the following syntax:

list(
  Results = list(
    list(
      GroupId = "string",
      MemberId = list(
        UserId = "string"
      ),
      MembershipExists = TRUE|FALSE
    )
  )
)

Request syntax

svc$is_member_in_groups(
  IdentityStoreId = "string",
  MemberId = list(
    UserId = "string"
  ),
  GroupIds = list(
    "string"
  )
)