CreateUser - Amazon Chime

CreateUser

Creates a user under the specified Amazon Chime account.

Request Syntax

POST /accounts/accountId/users?operation=create HTTP/1.1 Content-type: application/json { "Email": "string", "Username": "string", "UserType": "string" }

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Email

The user's email address.

Type: String

Pattern: .+@.+\..+

Required: No

Username

The user name.

Type: String

Required: No

UserType

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "User": { "AccountId": "string", "AlexaForBusinessMetadata": { "AlexaForBusinessRoomArn": "string", "IsAlexaForBusinessEnabled": boolean }, "DisplayName": "string", "InvitedOn": number, "LicenseType": "string", "PersonalPIN": "string", "PrimaryEmail": "string", "PrimaryProvisionedNumber": "string", "RegisteredOn": number, "UserId": "string", "UserInvitationStatus": "string", "UserRegistrationStatus": "string", "UserType": "string" } }

Response Elements

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

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

User

The user on the Amazon Chime account.

Type: User object

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

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

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

Example

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 creates a shared device profile for the specified email address.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=create HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.17.3 Python/3.8.0 Windows/10 botocore/1.14.3 X-Amz-Date: 20200115T223809Z AUTHPARAMS {"Email": "roomdevice@example.com", "UserType": "SharedDevice"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 4225c49a-307a-413b-bc8f-37bb145c1483 Content-Type: application/json Content-Length: 664 Date: Wed, 15 Jan 2020 22:38:09 GMT Connection: keep-alive {"User":{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","AlexaForBusinessMetadata":{"AlexaForBusinessRoomArn":null,"IsAlexaForBusinessEnabled":false},"Delegates":null,"Devices":null,"DisplayName":"room device","EmailAlias":[],"FullName":"Room Device","InvitedOn":null,"IsProTrial":false,"LastActiveOn":null,"LicenseType":"Pro","PersonalPIN":null,"PresenceVisibility":null,"PrimaryEmail":"roomdevice@example.com","PrimaryProvisionedNumber":null,"RegisteredOn":"2020-01-15T22:38:09.806Z","UserId":"1ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus":null,"UserLocale":null,"UserRegistrationStatus":"Registered","UserType":"SharedDevice","Vanity":null}}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: