AWSCognitoIdentityProviderListUsersRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Represents the request to list users.

Required parameters: [UserPoolId]

  attributesToGet

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned.

@property (nonatomic, strong) NSArray<NSString*> *attributesToGet

Declared In

AWSCognitoIdentityProviderModel.h

  filter

A filter string of the form "AttributeNameFilter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

  • AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

  • Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".

  • AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

  • username (case-sensitive)

  • email

  • phone_number

  • name

  • given_name

  • family_name

  • preferred_username

  • cognito:user_status (called Enabled in the Console) (case-sensitive)

  • status (case-insensitive)

Custom attributes are not searchable.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

@property (nonatomic, strong) NSString *filter

Declared In

AWSCognitoIdentityProviderModel.h

  limit

Maximum number of users to be returned.

@property (nonatomic, strong) NSNumber *limit

Declared In

AWSCognitoIdentityProviderModel.h

  paginationToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

@property (nonatomic, strong) NSString *paginationToken

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolId

The user pool ID for the user pool on which the search should be performed.

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h