Get the First Confirmed Multi-factor Authentication (MFA) Enrollment

Retrieve the first multi-factor authentication enrollment that a specific user has confirmed.

GET https://{tenantDomain}/api/v2/users/{id}/enrollments

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.Enrollments.GetAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Users.Enrollments.Get(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().enrollments().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->enrollments->get(
    'id',
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.enrollments.get(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.enrollments.get(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.enrollments.get("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.enrollments.get("id");
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/users/{id}/enrollments \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "type": "<string>",
    "name": "<string>",
    "identifier": "<string>",
    "phone_number": "<string>",
    "enrolled_at": "2023-11-07T05:31:56Z",
    "last_auth": "2023-11-07T05:31:56Z"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the user to list enrollments for.

Response

200

application/json

Enrollments successfully retrieved.

id · string

ID of this enrollment.

status · enum<string>

Status of this enrollment. Can be pending or confirmed.

Available options: pending, confirmed

type · string

Type of enrollment.

name · string

Name of enrollment (usually phone number).

Maximum string length: 20

identifier · string

Device identifier (usually phone identifier) of this enrollment.

phone_number · string

Phone number for this enrollment.

auth_method · enum<string>

Authentication method for this enrollment. Can be authenticator, guardian, sms, webauthn-roaming, or webauthn-platform.

Available options: authenticator, guardian, sms, webauthn-platform, webauthn-roaming

enrolled_at · string<date-time>

Start date and time of this enrollment.

last_auth · string<date-time>

Last authentication date and time of this enrollment.