All Products
Search
Document Center

Identity as a Service:GetPasswordExpirationConfiguration

Last Updated:Dec 17, 2024

Queries the password expiration configurations of 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:GetPasswordExpirationConfigurationget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

idaas_ue2jvisn35ea5lmthk267xxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The password expiration configurations.

PasswordExpirationStatusstring

Indicates whether the password expiration feature is enabled. Valid values:

  • enabled
  • disabled
enabled
PasswordValidMaxDayinteger

The validity period of a password. Unit: day.

180
PasswordExpirationActionstring

The action to take when a password expires. Valid values:

  • forbid_login: Prohibit the user from using the password to log on to IDaaS.
  • force_update_password: Force the user to change the password.
  • remind_update_password: Remind the user to change the password.
forbid_login
PasswordExpirationNotificationStatusstring

Indicates whether the password expiration notification feature is enabled. Valid values:

  • enabled
  • disabled
enabled
PasswordExpirationNotificationChannelsarray

The methods for receiving password expiration notifications.

PasswordExpirationNotificationChannelstring

The method for receiving password expiration notifications. Valid values:

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

The number of days before the expiration date during which password expiration notifications are sent. Unit: day.

7
PasswordForcedUpdateDurationinteger

The number of days before which users must change the password to prevent password expiration. Unit: day.

3
EffectiveAuthenticationSourceIdsarray

The list of valid authentication IDs. The default is all ["ia_all"]

ia_all: All. If you fill in this value, you cannot fill in other values

ia_password: Account password login

ia_otp_sms: SMS verification code login method

ia_webauthn: WebAuthn authenticator login method

idp_xxx: Specific identity provider authentication method

EffectiveAuthenticationSourceIdsstring

authentication ID

ia_all

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "PasswordExpirationConfiguration": {
    "PasswordExpirationStatus": "enabled",
    "PasswordValidMaxDay": 180,
    "PasswordExpirationAction": "forbid_login",
    "PasswordExpirationNotificationStatus": "enabled",
    "PasswordExpirationNotificationChannels": [
      "login"
    ],
    "PasswordExpirationNotificationDuration": 7,
    "PasswordForcedUpdateDuration": 3,
    "EffectiveAuthenticationSourceIds": [
      "ia_all"
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history