Creating a Desktop Name Policy

Function

Creates a desktop name policy to automatically generate desktop names.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:tenants:createDesktopNamePolicy	Write	-	-	-	-

URI

POST /v2/{project_id}/desktop-name-policies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
policy_name	Yes	String	Policy name. The value is a string of 1 to 30 characters, including digits, letters, and underscores (). It must start with a letter or underscore ().
name_prefix	Yes	String	Policy prefix.
digit_number	Yes	Integer	Number of valid digits in the policy suffix.
start_number	Yes	Integer	Start number of the policy suffix.
single_domain_user_inc	Yes	Integer	Indicates whether the user name increases in ascending order. The value 1 indicates that the user name increases in ascending order. The value 0 indicates that the number of tenants increases.
is_default_policy	No	Boolean	Indicates whether the policy is the default policy. The value true indicates the default policy.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policy_id	String	Policy ID.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "policy_name" : "MyPolicy",
  "name_prefix" : "abc$DomainUser$12",
  "digit_number" : 2,
  "start_number" : 1,
  "single_domain_user_inc" : 1,
  "is_default_policy" : false
}

Example Responses

Status code: 200

Response to the request for creating a desktop name policy.

{
  "policy_id" : "string"
}

Status Codes

Status Code	Description
200	Response to the request for creating a desktop name policy.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permission.
500	Internal Server Error