Skip to content

Retrieve an authenticator enrollment

Request

Identity Engine
OAuth 2.0 scope:
  • okta.users.read

Retrieves a user's authenticator enrollment by enrollmentId

Path
userIdstringrequired

ID of an existing Okta user

Example:00ub0oNGTSWTBKOLGLNR
enrollmentIdstringrequired

Unique identifier of an enrollment

Example:sms8lqwuzSpWT4kVs0g4
Query
discloseIdentifiersArray of strings

Indicates whether or not the identifier of an authenticator enrollment is disclosed or anonymized. If it's included in the operation query, then the identifier of the authenticator enrollment (the actual phone number, for example) is included in the response.

Items Value:"phone"
curl -i -X GET \
  'https://subdomain.okta.com/api/v1/users/00ub0oNGTSWTBKOLGLNR/authenticator-enrollments/sms8lqwuzSpWT4kVs0g4?discloseIdentifiers=phone'

Responses

Success

Bodyapplication/json
createdstring, (date-time)

Timestamp when the authenticator enrollment was created

idstring

The unique identifier of the authenticator enrollment

keystring

A human-readable string that identifies the authenticator

lastUpdatedstring, (date-time)

Timestamp when the authenticator enrollment was last updated

namestring

The authenticator display name

profileobject(AuthenticatorProfile)

Defines the authenticator specific parameters

statusstring

Status of the enrollment

typestring(AuthenticatorType)

The type of authenticator

Enum:"app""email""federated""password""phone""security_key""security_question""tac""proximity"
Response
{ "type": "phone", "id": "sms8evhwh0Ne35iPR0g7", "key": "phone_number", "status": "ACTIVE", "name": "Phone", "created": "2020-07-26T21:05:23.000Z", "lastUpdated": "2020-07-29T00:21:29.000Z", "profile": { "phoneNumber": "+1 XXX-XXX-6065" }, "nickname": "Joe's Work Phone", "_links": { "self": { … }, "user": { … }, "authenticator": { … } } }