ListUsersRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListUsers operation. Lists users and their basic details in a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.ListUsersRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class ListUsersRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The ListUsersRequest type exposes the following members

Constructors

	Name	Description
	ListUsersRequest()

Properties

Name	Type	Description
AttributesToGet	System.Collections.Generic.List<System.String>	Gets and sets the property AttributesToGet. 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. Use `AttributesToGet` with required attributes in your user pool, or in conjunction with `Filter`. Amazon Cognito returns an error if not all users in the results have set a value for the attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in every user profile before an `AttributesToGet` parameter returns results.
Filter	System.String	Gets and sets the property Filter. 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 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.
Limit	System.Int32	Gets and sets the property Limit. Maximum number of users to be returned.
PaginationToken	System.String	Gets and sets the property PaginationToken. This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool on which the search should be performed.

Examples

This request submits a value for all possible parameters for ListUsers. By iterating the PaginationToken, you can page through and collect all users in a user pool.

A ListUsers request for the next 3 users whose email address starts with "testuser."


var client = new AmazonCognitoIdentityProviderClient();
var response = client.ListUsers(new ListUsersRequest 
{
    AttributesToGet = new List<string> {
        "email",
        "sub"
    },
    Filter = "\"email\"^=\"testuser\"",
    Limit = 3,
    PaginationToken = "abcd1234EXAMPLE",
    UserPoolId = "us-east-1_EXAMPLE"
});

string paginationToken = response.PaginationToken;
List<UserType> users = response.Users;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5