AWSCognitoIdentityProviderListUsersRequest

Objective-C

@interface AWSCognitoIdentityProviderListUsersRequest

Swift

class AWSCognitoIdentityProviderListUsersRequest

Represents the request to list users.

Required parameters: [UserPoolId]

  • A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to include in the response for each user. When you don’t provide an AttributesToGet parameter, Amazon Cognito returns all attributes for each user.

    Declaration

    Objective-C

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

    Swift

    var attributesToGet: [String]? { get set }

  • 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 Status in the Console) (case-insensitive)

    • status (called Enabled in the Console) (case-sensitive)

    • sub

    Custom attributes aren’t searchable.

    You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

    For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable filter;

    Swift

    var filter: String? { get set }

  • Maximum number of users to be returned.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable limit;

    Swift

    var limit: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable paginationToken;

    Swift

    var paginationToken: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }