Skip to main content

IIdentityStoreListGroupsRequest

Interface in AWS.IdentityStore

Interface for ListGroups requests.

Ancestors

Properties

Filters

property Filters: TList<IIdentityStoreFilter>

Type: IIdentityStoreFilter

A list of filters to apply when listing groups.

This property allows restricting results to groups that match specific attribute values. Currently, only the DisplayName attribute is supported for filtering. Each filter must specify an AttributePath (e.g., DisplayName) and a corresponding AttributeValue. The value must be a valid JSON string literal, such as "Engineering".

IdentityStoreId

property IdentityStoreId: string

The identifier of the identity store containing the groups.

MaxResults

property MaxResults: TOptional<Integer>

(Optional) The maximum number of results to return in a single response.

NextToken

property NextToken: string

(Optional) A pagination token from a previous call, if applicable.

Methods

AddFilter

function AddFilter(const AFilter: IIdentityStoreFilter): NativeInt; overload;

IIdentityStoreFilter

Add a filter to the list of Filters.

Parameters

NameDescription
AFilterSpecify the filter to add to the list of Filters

Returns

Returns the index of the filter added to Filters.


function AddFilter(const AAttributePath, AAttributeValue: string): NativeInt; overload;

Add a filter to the list of Filters.

Parameters

NameDescription
AAttributePathSpecify the name of the attribute to filter on, such as.
AAttributeValueSpecify the JSON-formatted value to match for the specified attribute.

Returns

Returns the index of the filter added to Filters.