Skip to main content

CreateAuthenticationInput

User account creation parameters for new user registration.

Contains all necessary information to create a new user account including credentials, profile information, and initial authorization claims.

input CreateAuthenticationInput {
  email: String!
  password: String
  phoneNumber: String
  displayName: String
  uid: String
  claims: CreateAuthenticationClaimsInput
}

Fields​

CreateAuthenticationInput.email ● String! non-null scalar​

User's email address for account identification and communication.

Must be a valid email format and will serve as the primary identifier for the user account. This email will be used for login and account recovery.

CreateAuthenticationInput.password ● String scalar​

User's password for account security.

Must be at least 6 characters long. If not provided, the user will need to set a password through the password initialization process.

CreateAuthenticationInput.phoneNumber ● String scalar​

User's phone number for contact and verification purposes.

Should be provided in international format for optimal compatibility with verification systems.

CreateAuthenticationInput.displayName ● String scalar​

User's display name for profile presentation.

This name will be shown in user interfaces and can be different from the user's legal name. Used for personalization and user experience.

CreateAuthenticationInput.uid ● String scalar​

External system identifier for user account linking.

Used to associate this user account with accounts in external systems or to maintain consistency during migrations.

CreateAuthenticationInput.claims ● CreateAuthenticationClaimsInput input​

Initial authorization claims and permissions for the new user.

Defines the user's initial roles, permissions, and access rights within the system. If not provided, default user permissions will be applied.

Member Of​

authenticationCreate mutation