Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListUsers

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

Note

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the AWS IAM Identity Center User Guide.

Request Syntax


{
   "Extensions": [ "string" ],
   "Filters": [ 
      { 
         "AttributePath": "string",
         "AttributeValue": "string"
      }
   ],
   "IdentityStoreId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Extensions

A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: aws:identitystore:[a-z]{1,20}

Required: No

Filters

This parameter has been deprecated.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Type: Array of Filter objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

IdentityStoreId

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

MaxResults

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Pattern: [-a-zA-Z0-9+=/:_]*

Required: No

Response Syntax


{
   "NextToken": "string",
   "Users": [ 
      { 
         "Addresses": [ 
            { 
               "Country": "string",
               "Formatted": "string",
               "Locality": "string",
               "PostalCode": "string",
               "Primary": boolean,
               "Region": "string",
               "StreetAddress": "string",
               "Type": "string"
            }
         ],
         "Birthdate": "string",
         "CreatedAt": number,
         "CreatedBy": "string",
         "DisplayName": "string",
         "Emails": [ 
            { 
               "Primary": boolean,
               "Type": "string",
               "Value": "string"
            }
         ],
         "Extensions": { 
            "string" : JSON value 
         },
         "ExternalIds": [ 
            { 
               "Id": "string",
               "Issuer": "string"
            }
         ],
         "IdentityStoreId": "string",
         "Locale": "string",
         "Name": { 
            "FamilyName": "string",
            "Formatted": "string",
            "GivenName": "string",
            "HonorificPrefix": "string",
            "HonorificSuffix": "string",
            "MiddleName": "string"
         },
         "NickName": "string",
         "PhoneNumbers": [ 
            { 
               "Primary": boolean,
               "Type": "string",
               "