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

ListUsers

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

Request Syntax


GET /accounts/accountId/users?max-results=MaxResults&next-token=NextToken&user-email=UserEmail&user-type=UserType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

MaxResults

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

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

NextToken

The token to use to retrieve the next page of results.

UserEmail

Optional. The user email address used to filter results. Maximum 1.

Pattern: .+@.+\..+

UserType

The user type.

Valid Values: PrivateUser | SharedDevice

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Users": [ 
      { 
         "AccountId": "string",
         "AlexaForBusinessMetadata": { 
            "AlexaForBusinessRoomArn": "string",
            "IsAlexaForBusinessEnabled": boolean
         },
         "DisplayName": "string",
         "InvitedOn": "string",
         "LicenseType": "string",
         "PersonalPIN": "string",
         "PrimaryEmail": "string",
         "PrimaryProvisionedNumber": "string",
         "RegisteredOn": "string",
         "UserId": "string",
         "UserInvitationStatus": "string",
         "UserRegistrationStatus": "string",
         "UserType": "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.

Type: String

Users

List of users and user details.

Type: Array of User objects

Errors

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

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples

In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example lists the users for the specified Amazon Chime account.

Sample Request


GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T165935Z Authorization: AUTHPARAMS

Sample Response


HTTP/1.1 200 OK x-amzn-RequestId: 429f487b-6f1d-4a76-8361-9809f6885ee8 Content-Type: application/json Content-Length: 2200 Date: Tue, 08 Jan 2019 16:59:36 GMT Connection: keep-alive {"NextToken": null,"Users": [{"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName": "user1","EmailAlias": [],"FullName": "user1","InvitedOn": null,"IsProTrial": false,"LastActiveOn": null,"LicenseType": "Pro","PersonalPIN": null,"PresenceVisibility": null,"PrimaryEmail": "user1@example.com","PrimaryProvisionedNumber": null,"RegisteredOn": "2018-12-20T18:45:25.231Z","UserId": "1ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale": null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName": "user2","EmailAlias": [],"FullName": "user2","InvitedOn": null,"IsProTrial": false,"LastActiveOn": null,"LicenseType": "Pro","PersonalPIN": null,"PresenceVisibility": null,"PrimaryEmail": "user2@example.com","PrimaryProvisionedNumber": null,"RegisteredOn": "2018-12-20T18:45:45.415Z","UserId": "2ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale": null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName": "user3","EmailAlias": [],"FullName": "user3","InvitedOn": null,"IsProTrial": false,"LastActiveOn": null,"LicenseType": "Basic","PersonalPIN": null,"PresenceVisibility": null,"PrimaryEmail": "user3@example.com","PrimaryProvisionedNumber": null,"RegisteredOn": "2018-12-20T18:46:57.747Z","UserId": "3ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale": null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName": "user4","EmailAlias": [],"FullName": "user4","InvitedOn": null,"IsProTrial": false,"LastActiveOn": null,"LicenseType": "Basic","PersonalPIN": null,"PresenceVisibility": null,"PrimaryEmail": "user4@example.com","PrimaryProvisionedNumber": null,"RegisteredOn": "2018-12-20T18:47:15.390Z","UserId": "4ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale": null,"UserRegistrationStatus": "Registered","Vanity": null}] }