Amazon Chime
API Reference (API Version 2018-05-01)

UpdateUser

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Request Syntax

POST /accounts/accountId/users/userId HTTP/1.1 Content-type: application/json { "LicenseType": "string" }

URI Request Parameters

The request requires the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

userId

The user ID.

Pattern: .*\S.*

Request Body

The request accepts the following data in JSON format.

LicenseType

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "User": { "AccountId": "string", "DisplayName": "string", "InvitedOn": number, "LicenseType": "string", "PersonalPIN": "string", "PrimaryEmail": "string", "PrimaryProvisionedNumber": "string", "RegisteredOn": number, "UserId": "string", "UserInvitationStatus": "string", "UserRegistrationStatus": "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.

User

The updated user details.

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

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 updates the specified details for the specified user.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k 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: 20190108T215020Z Authorization: AUTHPARAMS Content-Length: 24 {"LicenseType": "Basic"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 3a63e2de-eb6c-41cf-8b08-2b05a29ee461 Content-Type: application/json Content-Length: 441 Date: Tue, 08 Jan 2019 21:50:20 GMT Connection: keep-alive { "User": { "AccountId": null, "Delegates": null, "Devices": null, "DisplayName": null, "EmailAlias": null, "FullName": null, "InvitedOn": null, "IsProTrial": null, "LastActiveOn": null, "LicenseType": null, "PersonalPIN": null, "PresenceVisibility": null, "PrimaryEmail": null, "PrimaryProvisionedNumber": null, "RegisteredOn": null, "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k", "UserInvitationStatus": null, "UserLocale": null, "UserRegistrationStatus": null, "Vanity": null } }

See Also

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