ListUsersRequest

import type { ListUsersRequest } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";

Represents the request to list users.

interface ListUsersRequest {

AttributesToGet?: string[] | null;

Filter?: string | null;

Limit?: number | null;

PaginationToken?: string | null;

UserPoolId: string;

}

§Properties

AttributesToGet?: string[] | null

[src]

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 null, all attributes are returned.

Filter?: string | null

[src]

A filter string of the form "AttributeName Filter-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 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.

Limit?: number | null

[src]

Maximum number of users to be returned.

PaginationToken?: string | null

[src]

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.

UserPoolId: string

[src]

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