Récupérer les méthodes d’authentification

Récupérer la liste détaillée des méthodes d’authentification associées à un utilisateur donné.

GET https://{tenantDomain}/api/v2/users/{id}/authentication-methods

Go

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.ListUserAuthenticationMethodsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Users.AuthenticationMethods.List(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "aaguid": "<string>",
    "authentication_methods": [
      {
        "id": "<string>"
      }
    ],
    "confirmed": true,
    "credential_backed_up": true,
    "credential_device_type": "<string>",
    "email": "<string>",
    "enrolled_at": "2023-11-07T05:31:56Z",
    "identity_user_id": "<string>",
    "key_id": "<string>",
    "last_auth_at": "2023-11-07T05:31:56Z",
    "link_id": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "public_key": "<string>",
    "relying_party_identifier": "<string>",
    "transports": [
      "<string>"
    ],
    "user_agent": "<string>",
    "user_handle": "<string>"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

L’ID de l’utilisateur en question.

Paramètres de requête

page · integer

Indice de page des résultats à renvoyer. La première page est 0. La valeur par défaut est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 0 <= x <= 100

include_totals · boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou sous la forme d’un tableau de résultats direct (false, valeur par défaut).

Réponse

200

application/json

Les méthodes d’authentification de l’utilisateur ont été récupérées.

object[]

object

created_at · string<date-time> · requis

Date de création de l’authentificateur

id · string · requis

L’ID de la méthode d’authentification (généré automatiquement)

type · enum<string> · requis

Options disponibles: recovery-code, totp, push, phone, email, email-verification, webauthn-roaming, webauthn-platform, guardian, passkey, password

aaguid · string

S’applique uniquement aux méthodes d’authentification par clé d’accès. Identifiant global unique de l’attestation de l’authentificateur.

authentication_methods · object[]

Show child attributes

confirmed · boolean

Le statut de la méthode d’authentification

credential_backed_up · boolean

S’applique uniquement aux clés d’accès. Indique si l’information d’identification a été sauvegardée.

credential_device_type · string

S’applique uniquement aux clés d’accès. Le type d’appareil sur lequel l’information d’identification est stockée, selon sa capacité de sauvegarde. Les informations d’identification "single_device" ne peuvent pas être sauvegardées ni synchronisées vers un autre appareil, tandis que les informations d’identification "multi_device" peuvent être sauvegardées si l’utilisateur final l’a activé.

email · string

S’applique uniquement aux méthodes d’authentification par courriel et de vérification du courriel. L’adresse de courriel utilisée pour envoyer des messages de vérification.

enrolled_at · string<date-time>

Date d’inscription

identity_user_id · string

S’applique uniquement aux clés d’accès. L’ID de l’identité utilisateur liée à la méthode d’authentification.

key_id · string

S’applique uniquement aux méthodes d’authentification WebAuthn. L’ID de l’information d’identification générée.

last_auth_at · string<date-time>

Dernière authentification

link_id · string

L’ID d’une méthode d’authentification liée. Les méthodes d’authentification liées seront supprimées ensemble.

name · string

Un libellé en langage clair pour identifier la méthode d’authentification

Maximum string length: 20

phone_number · string

S’applique uniquement aux méthodes d’authentification par téléphone. Le numéro de téléphone de destination utilisé pour envoyer des codes de vérification par message texte et par appel vocal.

preferred_authentication_method · enum<string>

S’applique uniquement aux méthodes d’authentification par téléphone. Méthode de communication privilégiée.

Options disponibles: voice, sms

public_key · string

S’applique uniquement aux méthodes d’authentification WebAuthn. La clé publique.

relying_party_identifier · string

S’applique uniquement aux méthodes d’authentification WebAuthn/par clé d’accès. L’identifiant de Relying Party de l’information d’identification.

transports · string[]

S’applique uniquement aux clés d’accès. Les transports utilisés par les clients pour communiquer avec l’authentificateur.

user_agent · string

S’applique uniquement aux clés d’accès. La chaîne user-agent du navigateur utilisé pour créer la clé d’accès.

user_handle · string

S’applique uniquement aux clés d’accès. Le handle utilisateur de l’identité utilisateur.