Get a multi-factor authentication enrollment

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Guardian.Enrollments.Get(
        context.TODO(),
        "id",
    )
}

200

{
  "id": "dev_0000000000000001",
  "status": "pending",
  "name": "iPhone 7",
  "identifier": "76dc-a90c-a88c-a90c-a88c-a88c-a90c",
  "phone_number": "[phone]",
  "enrolled_at": "2016-07-12T17:56:26.804Z",
  "last_auth": "2016-07-12T17:56:26.804Z"
}

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 enrollment to be retrieve.

Response

200

application/json

Enrollment successfully retrieved.

id · string · default: dev_0000000000000001 · required

ID for this enrollment.

status · enum<string> · default: pending

Status of this enrollment. Can be pending or confirmed.

Available options: pending, confirmed

name · string · default: iPhone 7

Device name (only for push notification).

Required string length: 1 - 20

Pattern: ^\+[0-9]{8, 20}

identifier · string · default: 76dc-a90c-a88c-a90c-a88c-a88c-a90c

Device identifier. This is usually the phone identifier.

phone_number · string · default: [phone]

Phone number.

enrolled_at · string · default: 2016-07-12T17:56:26.804Z

Enrollment date and time.

last_auth · string · default: 2016-07-12T17:56:26.804Z

Enrollment date and time.