CloudSSO Password Policy Overview - CloudSSO - Alibaba Cloud - CloudSSO

Queries the password policy of CloudSSO users.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetPasswordPolicy

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the CloudSSO directory.	d-00fc2p61****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	B7C6E839-FB65-59BE-B753-003AA8AF7DF7
PasswordPolicy	object	The password policy.
MinPasswordLength	integer	The minimum password length. Valid values: 8 to 32 characters.	8
MinPasswordDifferentChars	integer	The minimum number of different characters in a password. A value of 0 indicates no restriction. The maximum value equals the value of the `MinPasswordLength` parameter.	8
PasswordNotContainUsername	boolean	Indicates whether to exclude the username from the password. Valid values: true: A password cannot contain the username. false: A password can contain the username.	true
MaxPasswordAge	integer	The validity period of a password. Valid values: 1 to 120. Unit: days.	90
PasswordReusePrevention	integer	The policy for password history check. The previous N passwords cannot be reused. Valid values of N: 0 to 24. The value 0 indicates that all historical passwords can be reused. Note Passwords that are generated before January 5, 2024 are not counted as historical passwords.	1
MaxLoginAttempts	integer	The maximum number of consecutive failed login attempts. If an incorrect password is entered for the specified number of consecutive times, the account is locked for 1 hour. Valid values: 0 to 32. The value 0 indicates that the number of password retries is not limited.	5
RequireNumbers	boolean	Indicates whether digits are required in a password. Valid values: true: Digits are required in a password. false: Digits are not required in a password.	true
RequireLowerCaseChars	boolean	Indicates whether lowercase letters are required in a password. Valid values: true: Lowercase letters are required in a password. false: Lowercase letters are not required in a password.	true
MaxPasswordLength	integer	The maximum password length.	32
RequireUpperCaseChars	boolean	Indicates whether uppercase letters are required in a password. Valid values: true: Uppercase letters are required in a password. false: Uppercase letters are not required in a password.	true
RequireSymbols	boolean	Indicates whether special characters are required in a password. Valid values: true: Special characters are required in a password. false: Special characters are not required in a password.	true
HardExpire	boolean	Indicates whether to disable logon after a password expires. Valid values: true: disables logon after a password expires. false: does not disable logon after a password expires.	true

Examples

Success response

JSON format

{
  "RequestId": "B7C6E839-FB65-59BE-B753-003AA8AF7DF7",
  "PasswordPolicy": {
    "MinPasswordLength": 8,
    "MinPasswordDifferentChars": 8,
    "PasswordNotContainUsername": true,
    "MaxPasswordAge": 90,
    "PasswordReusePrevention": 1,
    "MaxLoginAttempts": 5,
    "RequireNumbers": true,
    "RequireLowerCaseChars": true,
    "MaxPasswordLength": 32,
    "RequireUpperCaseChars": true,
    "RequireSymbols": true,
    "HardExpire": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.