---
title: Platform Username node
description: Configure the Platform Username node to prompt users to enter their username, optionally validate it against username policies, and store it in the shared node state.
component: platform
version: 7.5
page_id: platform:auth-node-ref:platform-username
canonical_url: https://docs.pingidentity.com/platform/7.5/auth-node-ref/platform-username.html
llms_txt: https://docs.pingidentity.com/platform/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
keywords: ["Nodes & Trees", "Journeys", "Authentication"]
page_aliases: ["auth-node-platform-username.adoc"]
section_ids:
  availability: Availability
  inputs: Inputs
  dependencies: Dependencies
  configuration: Configuration
  outputs: Outputs
  outcomes: Outcomes
  errors: Errors
  example: Example
---

# 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.

## Availability

| Product                                                                                                                                 | Available? |
| --------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| PingOne Advanced Identity Cloud                                                                                                         | Yes        |
| PingAM (self-managed)

This functionality requires that you configure AM as part of a sample Ping Identity Platform deployment. | Yes        |
| Ping Identity Platform (self-managed)                                                                                                   | Yes        |

## Inputs

None.

## Dependencies

If this node's Validate Username setting is enabled, the node relies on IDM for username policies.

## Configuration

| Property           | Usage                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Validate Username  | When enabled, this node uses the username policies in IDM 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 IDM for a validation request, this node throws an exception with a `Communication failure` message.

## Example

The following journey uses a [Page node](page.html) containing the [Platform Username node](platform-username.html) and [Platform Password node](platform-password.html) to collect the username and password and set their values in the shared node state:

![Username and password authentication](_images/platform-username-password.png)

* The [Page node](page.html) presents a page with input fields to prompt for the username and password.

  * The [Platform Username node](platform-username.html) collects and injects the `userName` into the shared node state.

  * The [Platform Password node](platform-password.html) collects and injects the `password` into the shared node state.

* The [Data Store Decision node](data-store-decision.html) uses the username and password to determine whether authentication is successful.

* The [Increment Login Count node](increment-login-count.html) updates the login count on successful authentication.

* The [Inner Tree Evaluator node](inner-tree-evaluator.html) invokes a nested journey for progressive profiling.