POST

/app-instance-users

http://service.chime.aws.amazon.com/app-instance-users

Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user.

Access Token Required: API Key

Body Params

Namestringrequired

The user's name.

Tagsarray

Tags assigned to the <code>AppInstanceUser</code>.

Metadatastring

The request's metadata. Limited to a 1KB string in UTF-8.

AppInstanceArnstringrequired

The ARN of the <code>AppInstance</code> request.

AppInstanceUserIdstringrequired

The user ID of the <code>AppInstance</code>.

ClientRequestTokenstringrequired

The token assigned to the user requesting an <code>AppInstance</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/app-instance-users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}