Is Member In Groups

identitystore_is_member_in_groups

R Documentation

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.
MemberId	[required] An object containing the identifier of a group member.
GroupIds	[required] A list of identifiers for groups in the identity store.

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"
  )
)