How to revoke software authorization for a user-Elastic Desktop Service-阿里云帮助中心

This API notifies an Independent Software Vendor (ISV) to revoke a user's software authorization. This action revokes the user's existing software license.

API description

Users are categorized as convenience users and Active Directory (AD) users. To revoke authorization, you must provide a list for at least one user type by configuring either the `edsSimpleUserList` or `edsAdUserList` parameter.

Request parameters

Name	Type	Required	Example	Description
action	String	Yes	CREATE_ORDER	The type of the request operation. Set the value to `LICENSE_DELETE_USERS`.
orderId	Long	Yes	1234512345	The order ID.
buyerId	Long	Yes	123451234512345	The buyer ID.
hashBuyerId	String	Yes	abc123abc123abc123	The value generated after the buyer ID is transformed by a hash algorithm.
edsUserType	String	Yes	SIMPLE	The user type. Valid values: `SIMPLE`: convenience user `AD`: AD user
edsSimpleUserList	String	No	[{ "userId": "1234", "userName": "alice", "userEmail": "a***@example.net"}]	The list of convenience users for whom to revoke authorization. This includes the following parameters: `userId`: The ID of the convenience user. `userName`: The name of the convenience user. `userEmail`: The mailbox of the convenience user.
edsAdUserList	String	No	[{ "userName": "alice", "workspaceName": "cn-hangzhou+dir-5628123***"}]	The list of AD users for whom to revoke authorization. This includes the following parameters: `userName`: The name of the AD user. `workspaceName`: The ID of the workspace to which the AD user belongs.

The following is an example of a request:

{
   "action": "LICENSE_ADD_USERS",
   "orderId": 1234512345,
   "buyerId": 123451234512345,
   "hashBuyerId": "abc123abc123abc123",
   "edsUserType": "SIMPLE",
   "edsSimpleUserList": [{ "userId": "1234", "userName": "alice", "userEmail": "a***@example.net"}],
   "edsAdUserList": [{ "userName": "alice", "workspaceName": "cn-hangzhou+dir-5628123***"}]
}

Response data

Name	Type	Example	Description
success	Boolean	true	Indicates whether the authorization was successfully revoked. Possible values: true: The authorization was successful. false: The authorization failed.
edsSimpleUserList	String	[{ "userId": "1234", "userName": "alice", "userEmail": "a***@example.net"}]	If the revocation is successful, a list of all authorized convenience users is returned. This includes the following parameters: `userId`: The ID of the convenience user. `userName`: The name of the convenience user. `userEmail`: The mailbox of the convenience user.
edsAdUserList	String	[{ "userName": "alice", "workspaceName": "cn-hangzhou+dir-5628123***"}]	If the revocation is successful, a list of all authorized AD users is returned. This includes the following parameters: `userName`: The name of the AD user. `workspaceName`: The ID of the workspace to which the AD user belongs.
errorMessage	String	error msg	If the revocation fails, the specific error message is returned.
errorCode	String	XXXX_YYYY	If the revocation fails, the specific error code is returned.

The following are examples of responses:

Successful revocation

{
    "success": true,
    "edsSimpleUserList": [{ "userId": "1234", "userName": "alice", "userEmail": "a***@example.net"}],
    "edsAdUserList": [{ "userName": "alice", "workspaceName": "cn-hangzhou+dir-5628123***"}],
    "errorMessage": null,
    "errorCode": null
}

Failed revocation

{
    "success": false,
    "edsSimpleUserList": [],
    "edsAdUserList": [],
    "errorMessage": "error msg",
    "errorCode": "XXXX_YYYY"
}