All Products
Search
Document Center

Identity as a Service:SetPasswordExpirationConfiguration

Last Updated:Dec 17, 2024

Configures a password expiration policy for an Employee Identity and Access Management (EIAM) instance of Identity as a Service (IDaaS).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eiam:SetPasswordExpirationConfigurationupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx
PasswordExpirationStatusstringYes

Specifies whether to enable the password expiration feature. Valid values:

  • enabled
  • disabled
enabled
PasswordValidMaxDayintegerNo

The validity period of a password. Unit: day. This parameter must be specified when PasswordExpirationStatus is set to enabled.

180
PasswordExpirationActionstringNo

The action to take upon password expiration. This parameter must be specified when PasswordExpirationStatus is set to enabled. Valid values:

  • forbid_login: Users cannot log on to IDaaS.
  • force_update_password: Users must change the password.
  • remind_update_password: IDaaS reminds users to change the password upon each logon.
force_update_password
PasswordExpirationNotificationStatusstringNo

Specifies whether to enable the password expiration notification feature. Valid values:

  • enabled
  • disabled
enabled
PasswordExpirationNotificationChannelsarrayNo

The methods for receiving password expiration notifications. This parameter must be specified when PasswordExpirationNotificationStatus is set to enabled.

stringNo

The method for receiving password expiration notifications. Valid values:

  • login: upon logon
  • email: by email
  • sms: by text message
login
PasswordExpirationNotificationDurationintegerNo

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
PasswordForcedUpdateDurationintegerNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history