Skip to main content

IIdentityStoreGroupMembershipExistenceResult

Interface in AWS.IdentityStore

Interface for IdentityStore GroupMembershipExistenceResult.

Properties

GroupId

property GroupId: string

The identifier of the group that was evaluated for membership.

This value corresponds to a group ID passed in the original request to IsMemberInGroups. It identifies the group for which the membership existence check was performed.

MemberId

property MemberId: IIdentityStoreMemberId

Type: IIdentityStoreMemberId

A structured identifier representing the user whose membership was evaluated.

This property contains the same MemberId used in the request and identifies the user whose membership status was checked for the specified group. It is returned in each result to confirm the evaluated user, especially in cases where batch operations or future API extensions may allow multiple members to be checked.

MembershipExists

property MembershipExists: TOptional<Boolean>

Indicates whether the user is a member of the specified group.

A value of true means the user is currently a member of the group. A value of false means the user is not a member of the group. This result is returned for each group evaluated in the request.