Identity Cloud

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?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

Yes

ForgeRock Identity Platform (self-managed)

Yes

Inputs

None.

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.

Only enable this field if you’re using this node as part of a registration journey. Don’t enable this field in an authentication journey because the validation includes verifying that the provided username doesn’t exist in the identity store.

Default: disabled

Username Attribute

The attribute used to store a username in the managed identity object.

Default: userName

Outputs

On success, this node updates the Username Attribute property in the shared node state with the username.

Outcomes

Single outcome path.

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:

Username and password authentication
Copyright © 2010-2024 ForgeRock, all rights reserved.