Removes one or more convenience users.
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Users | array | Yes | The usernames of the convenience users that you want to remove. | |
string | No | The username of the convenience user that you want to remove. | test1 |
Response parameters
Example
Normal return example
JSON
Format
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"RemoveUsersResult": {
"RemovedUsers": [
"test1"
],
"FailedUsers": [
{
"EndUserId": "test2",
"ErrorCode": "InvalidUsername",
"ErrorMessage": "test2 is an invalid username."
}
]
}
}
Error codes
For a list of error codes, visit the API error center.