How to grant software licenses to users-Elastic Desktop Service-阿里云帮助中心

This API is used to notify an Independent Software Vendor (ISV) to issue a software license to a user.

API description

Users are categorized as convenience users and Active Directory (AD) users. To grant permissions, you must provide a user list for at least one of these types by configuring the edsSimpleUserList parameter, the edsAdUserList parameter, or both.

Request parameters

Name	Type	Required	Example	Description
action	String	Yes	CREATE_ORDER	The type of the request operation. Set the value to `LICENSE_ADD_USERS`.
orderId	Long	Yes	1234512345	The order ID.
buyerId	Long	Yes	123451234512345	The buyer ID.
hashBuyerId	String	Yes	abc123abc123abc123	The value that is 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 to grant the license to. It 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 to grant the license to. It 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 a sample 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 successful. Valid values: true: The authorization was successful. false: The authorization failed.
edsSimpleUserList	String	[{ "userId": "1234", "userName": "alice", "userEmail": "a***@example.net"}]	If the authorization is successful, this parameter returns a list of all authorized convenience users. It 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 authorization is successful, this parameter returns a list of all authorized AD users. It 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	A specific error message is returned if the authorization fails.
errorCode	String	XXXX_YYYY	If the authorization fails, an error code is returned.

The following are sample responses:

Successful authorization

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

Failed authorization

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