Managing the Administrator Password

Updated on 2022-09-15 GMT+08:00

View PDF

Function

If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password.

URI

PUT /v3/{project_id}/instances/{instance_id}/admin-user

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region
instance_id	Yes	String	DDM instance ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Username of the administrator. The username: Can include 1 to 32 characters. Must start with a letter. Can contain only letters, digits, and underscores (_).
password	Yes	String	Password of the administrator. The password: Can include 8 to 32 characters. Must be a combination of uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_=+? Must be a strong password to improve security and prevent security risks such as brute force cracking.

Response Parameters

Status code: default

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Request

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user

{
  "name" : "root",
  "password" : "xxx"
}

Example Response

None

Status Codes

Status Code	Description
200	OK
default	Client or server error.

Error Codes

For details, see Error Codes.

Parent topic: DDM Accounts

Previous topic: Resetting the Password of a DDM Account

Next topic: Validating Password Strength

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel