All Products
Search
Document Center

Elastic Desktop Service:RemoveUsers

Last Updated:Dec 13, 2022

Removes one or more convenience users.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
UsersarrayYes

The usernames of the convenience users that you want to remove.

stringNo

The username of the convenience user that you want to remove.

test1

Response parameters

ParameterTypeDescriptionExample
object

The information that is returned.

RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
RemoveUsersResultobject

The result of removing the convenience user.

RemovedUsersarray

The convenience users that were removed.

string

The convenience user that was removed.

test1
FailedUsersarray

The convenience users that failed to be removed.

object

The convenience user that failed to be removed.

EndUserIdstring

The ID of the convenience user that failed to be removed.

test2
ErrorCodestring

The error code.

InvalidUsername
ErrorMessagestring

The error message.

test2 is an invalid username.

Example

Normal return example

JSONFormat

{
  "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.