Updated on 2025-10-16 GMT+08:00

Generating a Random Password

Function

This API is used to generate a random password.

Calling Method

For details, see Calling APIs.

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, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/csms/generate-password

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

password_policy_name

No

String

Policy name.

length

No

Integer

Length. The default value is 32.

exclude_characters

No

String

Character to be excluded.

exclude_lowercase

No

Boolean

Exclude lowercase letters. The default value is false.

exclude_uppercase

No

Boolean

Exclude uppercase letters. The default value is false.

exclude_numbers

No

Boolean

Exclude digits. The default value is false.

exclude_punctuation

No

Boolean

Exclude symbols. The default value is false.

include_space

No

Boolean

Spaces are included. The default value is false.

require_each_included_type

No

Boolean

Types that must be included. The default value is false.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 502

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 504

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

password

400

Invalid request parameter.

401

Username and password are required for the requested page.

403

Authentication failed.

404

Resource not found.

500

Internal server error.

502

Failed to complete the request. The server has received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.