Skip to main content
PATCH
Update details of an authentication method by ID

Authorizations

Authorization
string
header
required

Bearer and DPoP tokens are supported depending on the API configuration

Headers

x-correlation-id
string

A client-provided unique identifier for a single operation, used to correlate the request across Auth0 systems. The value is surfaced under references.correlation_id in tenant logs and echoed back on the response's x-correlation-id header. Invalid or oversized values are silently dropped and replaced by a generated UUID v4. Avoid including personally identifiable information (PII).

traceparent
string

A W3C Trace Context header used to correlate the request across distributed traces. When supplied, the inbound trace is continued and a fresh child span is echoed back on the response's traceparent header; the trace ID is also surfaced under references.trace_id in tenant logs. Malformed values are ignored.

Path Parameters

authentication_method_id
string
required

Authentication Method ID. This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.

Body

application/json

Request content for updating an authentication method

name
string

The friendly name of the authentication method

preferred_authentication_method
enum<string>

The preferred authentication method (for phone authenticators)

Available options:
sms,
voice

Response

Successfully updated authentication method

id
string
required

The unique identifier of the authentication method

created_at
string<date-time>
required

The date and time when the authentication method was created

usage
enum<string>[]
required

Primary and/or secondary factor

Usage type for authentication factors

Available options:
primary,
secondary
type
string
default:password
required

Authentication method type (factor)

Allowed value: "password"
identity_user_id
string
required

The ID of the user identity linked with the authentication method

last_password_reset
string<date-time>

The date of the last password reset