Configures a password expiration policy for an Employee Identity and Access Management (EIAM) instance of Identity as a Service (IDaaS).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
eiam:SetPasswordExpirationConfiguration | update | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The instance ID. | idaas_ue2jvisn35ea5lmthk267xxxxx |
PasswordExpirationStatus | string | Yes | Specifies whether to enable the password expiration feature. Valid values:
| enabled |
PasswordValidMaxDay | integer | No | The validity period of a password. Unit: day. This parameter must be specified when PasswordExpirationStatus is set to enabled. | 180 |
PasswordExpirationAction | string | No | The action to take upon password expiration. This parameter must be specified when PasswordExpirationStatus is set to enabled. Valid values:
| force_update_password |
PasswordExpirationNotificationStatus | string | No | Specifies whether to enable the password expiration notification feature. Valid values:
| enabled |
PasswordExpirationNotificationChannels | array | No | The methods for receiving password expiration notifications. This parameter must be specified when PasswordExpirationNotificationStatus is set to enabled. | |
string | No | The method for receiving password expiration notifications. Valid values:
| login | |
PasswordExpirationNotificationDuration | integer | No | The number of days before the expiration date during which password expiration notifications are sent. Unit: day. This parameter must be specified when PasswordExpirationNotificationStatus is set to enabled. | 7 |
PasswordForcedUpdateDuration | integer | No | The number of days before which users must change the password to prevent password expiration. Unit: day. You must set this parameter to a value greater than the value of PasswordExpirationNotificationDuration. | 7 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|