Skip to main content
POST
https://{tenantDomain}/api/v2
/
users
/
{id}
/
authentication-methods
Go
package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    client.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}
{
  "type": "phone",
  "id": "<string>",
  "name": "<string>",
  "totp_secret": "<string>",
  "phone_number": "<string>",
  "email": "<string>",
  "authentication_methods": [
    {
      "type": "totp",
      "id": "<string>"
    }
  ],
  "preferred_authentication_method": "voice",
  "key_id": "<string>",
  "public_key": "<string>",
  "aaguid": "<string>",
  "relying_party_identifier": "<string>",
  "credential_device_type": "single_device",
  "credential_backed_up": true,
  "identity_user_id": "<string>",
  "user_agent": "<string>",
  "user_handle": "<string>",
  "transports": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the user to whom the new authentication method will be assigned.

Body

​
type
enum<string>
required
Available options:
phone,
email,
totp,
webauthn-roaming,
passkey
​
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.

Required string length: 2 - 30
​
email
string

Applies to email authentication methods only. The email address used to send verification messages.

​
preferred_authentication_method
enum<string>

Applies to phone authentication methods only. The preferred communication method.

Available options:
voice,
sms
​
key_id
string

Applies to webauthn/passkey authentication methods only. The id of the credential.

​
public_key
string

Applies to webauthn/passkey authentication methods only. The public key, which is encoded as base64.

​
aaguid
string<uuid>

Applies to passkeys only. Authenticator Attestation Globally Unique Identifier

​
relying_party_identifier
string<hostname>

Applies to webauthn authentication methods only. The relying party identifier.

​
credential_device_type
enum<string>

Applies to passkeys only. The kind of device the credential is stored on as defined by backup eligibility. "single_device" credentials cannot be backed up and synced to another device, "multi_device" credentials can be backed up if enabled by the end-user.

Available options:
single_device,
multi_device
​
credential_backed_up
boolean

Applies to passkeys only. Whether the credential was backed up.

​
identity_user_id
string

Applies to passkeys only. The ID of the user identity linked with the authentication method.

​
user_agent
string

Applies to passkeys only. The user-agent of the browser used to create the passkey.

​
user_handle
string

Applies to passkeys only. The user handle of the user identity.

​
transports
string[]

Applies to passkeys only. The transports used by clients to communicate with the authenticator.

Response

Authentication method created.

The successfully created authentication method.

​
type
enum<string>
required
Available options:
phone,
email,
totp,
webauthn-roaming,
passkey
​
id
string<authenticator-id>

The ID of the newly created authentication method (automatically generated by the application)

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

Required string length: 2 - 30
​
email
string

Applies to email authentication methods only. The email address used to send verification messages.

​
authentication_methods
object[]
​
preferred_authentication_method
enum<string>

Preferred phone authentication method

Available options:
voice,
sms
​
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.

​
credential_device_type
enum<string>

Applies to passkeys only. The kind of device the credential is stored on as defined by backup eligibility. "single_device" credentials cannot be backed up and synced to another device, "multi_device" credentials can be backed up if enabled by the end-user.

Available options:
single_device,
multi_device
​
credential_backed_up
boolean

Applies to passkeys only. Whether the credential was backed up.

​
identity_user_id
string

Applies to passkeys only. The ID of the user identity linked with the authentication method.

​
user_agent
string

Applies to passkeys only. The user-agent of the browser used to create the passkey.

​
user_handle
string

Applies to passkeys only. The user handle of the user identity.

​
transports
string[]

Applies to passkeys only. The transports used by clients to communicate with the authenticator.

​
created_at
string<date-time>

Authentication method creation date