Skip to main content

ICognitoIdentityProviderListUsersRequest

Interface in AWS.CognitoIdentityProvider

Interface for ListUsers requests.

Ancestors​

Properties​

AttributesToGet​

property AttributesToGet: TList<string>

Specify a list of attributes to be returned for each user.

If not specified, all attributes will be returned.

Filter​

property Filter: string

Specify a filter string.

If not specified, all users will be returned. A filter string must be specified in the form AttributeName Filter-Type AttributeValue where: - AttributeName: is the name of the attribute to search. Only one attribute can be searched at a time. - Filter-Type: can be = for an exact match or ^= to match the start of a value. - AttributeValue: the value to match surrounded by double-quotes. For example: given_name = "Peter". Only standard attributes can be searched:

  • username (case-sensitive)
  • email
  • phone_number
  • name
  • given_name
  • family_name
  • preferred_username
  • cognito:user_status (called Status in the Console) (case-insensitive)
  • status (called Enabled in the Console) (case-sensitive)
  • sub

Limit​

property Limit: TOptional<Integer>

Specify a limit for number of users returned.

Valid range: 0 - 60.

PaginationToken​

property PaginationToken: string

Specify a PaginationToken returned from a previous request.

UserPoolId​

property UserPoolId: string

Specify the ID of the user pool.

Methods​

AddAttributeToGet​

function AddAttributeToGet(const AAttributeName: string): Integer;

Add an attribute to AttributesToGet

Parameters

NameDescription
AAttributeNameSpecify a user attribute to return in the search results.

Returns

Returns the index of the attribute added to AttributesToGet.