Auth0 · Schema

CreateUserAuthenticationMethodResponseContent

The successfully created authentication method.

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
id	string	The ID of the newly created authentication method (automatically generated by the application)
type	object
name	string	A human-readable label to identify the authentication method.
totp_secret	string	Base32 encoded secret for TOTP generation
phone_number	string	Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.
email	string	Applies to email authentication methods only. The email address used to send verification messages.
authentication_methods	array
preferred_authentication_method	object	Preferred phone authentication method
key_id	string	Applies to webauthn authenticators only. The id of the credential.
public_key	string	Applies to webauthn authenticators only. The public key.
aaguid	string	Applies to passkeys only. Authenticator Attestation Globally Unique Identifier.
relying_party_identifier	string	Applies to webauthn authenticators only. The relying party identifier.
created_at	string	Authentication method creation date

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUserAuthenticationMethodResponseContent",
  "title": "CreateUserAuthenticationMethodResponseContent",
  "type": "object",
  "description": "The successfully created authentication method.",
  "additionalProperties": false,
  "required": [
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the newly created authentication method (automatically generated by the application)",
      "format": "authenticator-id"
    },
    "type": {
      "$ref": "#/components/schemas/CreatedUserAuthenticationMethodTypeEnum"
    },
    "name": {
      "type": "string",
      "description": "A human-readable label to identify the authentication method."
    },
    "totp_secret": {
      "type": "string",
      "description": "Base32 encoded secret for TOTP generation"
    },
    "phone_number": {
      "type": "string",
      "description": "Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.",
      "minLength": 2,
      "maxLength": 30
    },
    "email": {
      "type": "string",
      "description": "Applies to email authentication methods only. The email address used to send verification messages."
    },
    "authentication_methods": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserAuthenticationMethodProperties"
      }
    },
    "preferred_authentication_method": {
      "$ref": "#/components/schemas/PreferredAuthenticationMethodEnum",
      "description": "Preferred phone authentication method"
    },
    "key_id": {
      "type": "string",
      "description": "Applies to webauthn authenticators only. The id of the credential."
    },
    "public_key": {
      "type": "string",
      "description": "Applies to webauthn authenticators only. The public key."
    },
    "aaguid": {
      "type": "string",
      "description": "Applies to passkeys only. Authenticator Attestation Globally Unique Identifier."
    },
    "relying_party_identifier": {
      "type": "string",
      "description": "Applies to webauthn authenticators only. The relying party identifier."
    },
    "created_at": {
      "type": "string",
      "description": "Authentication method creation date",
      "format": "date-time"
    }
  }
}