Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListUsers

Returns summaries of the organization's users.

Request Syntax


{
   "Filters": { 
      "DisplayNamePrefix": "string",
      "PrimaryEmailPrefix": "string",
      "State": "string",
      "UsernamePrefix": "string"
   },
   "MaxResults": number,
   "NextToken": "string",
   "OrganizationId": "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.

Filters

Limit the user search results based on the filter criteria. You can only use one filter per request.

Type: ListUsersFilters object

Required: No

MaxResults

The maximum number of results to return in a single call.

Type: Integer

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

Required: No

NextToken

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Type: String

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

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Required: No

OrganizationId

The identifier for the organization under which the users exist.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Users": [ 
      { 
         "DisabledDate": number,
         "DisplayName": "string",
         "Email": "string",
         "EnabledDate": number,
         "Id": "string",
         "Name": "string",
         "State": "string",
         "UserRole": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

Type: String

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

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Users

The overview of users for an organization.

Type: Array of User objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400