Update details of an authentication method by ID

Updates a single authentication method

PATCH https://{host}/me/v1/authentication-methods/{authentication_method_id}

Update details of an authentication method by ID

cURL

curl --request PATCH \
  --url https://{host}/me/v1/authentication-methods/{authentication_method_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

200

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "usage": [],
  "type": "password",
  "identity_user_id": "<string>",
  "last_password_reset": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer and DPoP tokens are supported depending on the API configuration

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

200

application/json

Successfully updated authentication method

password

passkey

recovery-code

push-notification

totp

webauthn-platform

webauthn-roaming

phone

email

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