Platform Username node
The Platform Username node prompts the user to enter their username and stores it in a configurable property of the shared node state.
Compatibility
Product | Compatible? |
---|---|
Advanced Identity Cloud |
Yes |
PingAM (self-managed) |
Yes |
Ping Identity Platform (self-managed) |
Yes |
Dependencies
If this node’s Validate Username setting is enabled, the node relies on the underlying identity service for username policies.
Configuration
Property | Usage | ||
---|---|---|---|
Validate Username |
When enabled, this node uses the username policies in the underlying identity service to validate the user’s input. It returns any policy failures as errors.
Default: disabled |
||
Username Attribute |
The attribute used to store a username in the managed identity object. Default: |
Outputs
On success, this node updates the Username Attribute property in the shared node state with the username.
Errors
This node does not log error or warning messages of its own.
If it fails to get the result from
the underlying identity service
for a validation request,
this node throws an exception with a Communication failure
message.
Example
The following journey uses a Page node containing the Platform Username node and Platform Password node to collect the username and password and set their values in the shared node state:
-
The Page node presents a page with input fields to prompt for the username and password.
-
The Platform Username node collects and injects the
userName
into the shared node state. -
The Platform Password node collects and injects the
password
into the shared node state.
-
-
The Data Store Decision node uses the username and password to determine whether authentication is successful.
-
The Increment Login Count node updates the login count on successful authentication.
-
The Inner Tree Evaluator node invokes a nested journey for progressive profiling.