This step type specifies an action to check a PingOne user’s password.

Step properties used with flow definitions

Configuration schema property Description
There are no configuration schema properties for the USER_PASSWORD_CHECK step.
Input property Description
user.id A string that specifies the user ID of the user account associated with the password check action. This is a required property.
user.password A string that specifies the user’s password to check. This is a required property.

The following properties are returned for the PASSWORD_VALID result.

Output property Description
passwordState.user.id A string that specifies the user’s password state.
passwordPolicy.id A string that specifies the password policy ID.
status A string that specifies the current status of the password.
lastChanged The date and time the password was last changed.
warnings.expires A string that specifies the date and time the password expires.

The following properties are returned for the PASSWORD_EXPIRED result.

Output property Description
passwordState.user.id A string that specifies the user’s password state.
passwordPolicy.id A string that specifies the password policy ID.
status A string that specifies the current status of the password.
lastChangedAt The date and time the password was last changed.
warnings.expires A string that specifies the date and time the password expires.

The following properties are returned for the MUST_CHANGE_PASSWORD result.

Output property Description
passwordState.user.id A string that specifies the user’s password state.
passwordPolicy.id A string that specifies the password policy ID.
status A string that specifies the current status of the password.
lastChangedAt The date and time the password was last changed.
warnings.expires A string that specifies the date and time the password expires.

Step properties used with flow executions

Flow state Description
There is no flow status associated with this step type.
Links Description
There are no flow actions associated with the USER_PASSWORD_CHECK step type.
Parameters Description
There are no flow action parameters associated with the USER_PASSWORD_CHECK step type.