Skip to main content

IIdentityStoreGroup

Interface in AWS.IdentityStore

Interface for IdentityStore Group.

Properties​

Description​

property Description: string

An optional description of the group's purpose or membership criteria.

This field provides additional context about the group, such as Finance Department Members or Project ABC Read Access.

DisplayName​

property DisplayName: string

The display name of the group.

This human-readable name identifies the group in user interfaces, access policies, and membership management. It is not required to be unique within the identity store.

ExternalIds​

property ExternalIds: TList<IIdentityStoreExternalId>

Type: IIdentityStoreExternalId

A list of external identifiers associated with the group.

Each entry in this list maps the group to an external identity provider or directory system, such as AzureAD or Okta. External identifiers are useful for synchronization, federation, and identity linking scenarios. Each external ID includes an Id and an optional Issuer string to indicate the source system.

GroupId​

property GroupId: string

The unique identifier assigned to the group by the identity store.

This value is used to reference the group in other operations such as DescribeGroup, CreateGroupMembership, or DeleteGroup.

IdentityStoreId​

property IdentityStoreId: string

The identifier of the identity store that contains the group.

This value uniquely identifies the AWS SSO identity store in which the group is defined. It ensures that group operations are correctly scoped to the intended identity store instance.