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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. |
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
- |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 502
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error codes |
|
error_msg |
String |
Error description |
Status code: 504
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot