SetPasswordExpirationConfiguration - Identity as a Service

Sets the password expiration policy for a specified EIAM instance.

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 support 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

eiam:SetPasswordExpirationConfiguration

update

*Instance

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PasswordExpirationStatus	string	Yes	The status of the password expiration configuration. Valid values: enabled: The password expiration configuration is enabled. disabled: The password expiration configuration is disabled.	enabled
PasswordValidMaxDay	integer	No	The validity period of a password in days. This parameter is required when PasswordExpirationStatus is set to enabled.	180
PasswordExpirationAction	string	No	The action to be performed when a password expires. This parameter is required when PasswordExpirationStatus is set to enabled. Valid values: forbid_login: Prohibit logon. force_update_password: Force the user to change the password. remind_update_password: Remind the user to change the password.	force_update_password
PasswordExpirationNotificationStatus	string	No	The status of the password expiration notification. Valid values: enabled: The password expiration notification is enabled. disabled: The password expiration notification is disabled.	enabled
PasswordExpirationNotificationChannels	array	No	The list of notification channels for password expiration. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.	login
	string	No	The notification channel for password expiration. Valid values: login: User logon. email: Email. sms: Text message.	login
PasswordExpirationNotificationDuration	integer	No	The time when a password expiration notification is sent. Unit: days. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.	7
PasswordForcedUpdateDuration	integer	No	The time when a user is forced to change the password. Unit: days. The value of this parameter must be greater than the value of PasswordExpirationNotificationDuration.	7
EffectiveAuthenticationSourceIds	array	No	The list of IDs of authentication sources that take effect.
	string	No	The ID of an authentication source that takes effect.	ia_passwordxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.