Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow.
Example
export interface Identifier {
  /**
   * The type of identifier, such as `'email'`, `'phone'`, or `'username'`.
   *
   * @see IdentifierType
   */
  type: IdentifierType;

  /**
   * Whether this identifier is required for signup.
   */
  required: boolean;
}

​
Example

const emailIdentifier: Identifier = {
  type: 'email',
  required: true
};

​
Properties

​
required
boolean
Whether this identifier is required for signup.
​
type
ScreenIdentifierType
The type of identifier, such as 'email', 'phone', or 'username'.Type