Authenticators

The MyAccount Authenticators API provides operations to list all available authenticators and enrollments.

API versioning

A valid API version in the Accept header is required to access the API. Current version: 1.0.0

Accept: application/json; okta-version=1.0.0

List all Authenticators
OAuth 2.0: okta.myAccount.authenticators.read

Lists all of the authenticators for the current user

Request
query Parameters
expand
string

Optional additional items to return in the _embedded object. Currently supports the value enrollments.

Example: expand=enrollments
Responses
200

Authenticators

403

Forbidden

429

Too Many Requests

get/idp/myaccount/authenticators
Request samples 
Response samples 
application/json
[]
Retrieve an Authenticator
Identity Engine
OAuth 2.0: okta.myAccount.authenticators.read
Retrieves an authenticator by authenticatorId


Request 
path Parameters
authenticatorId
required
string
id of the authenticator


 
 Example:  aut9gnvcjUHIWb37J0g4
query Parameters
expand
string
Optional additional items to return in the _embedded object. Currently supports the value enrollments.


 
 Example:  expand=enrollments
Responses 
200
Authenticator


403
Forbidden


404
Not Found


429
Too Many Requests


get/idp/myaccount/authenticators/{authenticatorId}
Request samples 
Response samples 
application/json
{}
List all Enrollments
Identity Engine
OAuth 2.0: okta.myAccount.authenticators.read
Lists all enrollments the current user has for an authenticator


Request 
path Parameters
authenticatorId
required
string
id of the authenticator


 
 Example:  aut9gnvcjUHIWb37J0g4
Responses 
200
Enrollments


403
Forbidden


404
Not Found


429
Too Many Requests


get/idp/myaccount/authenticators/{authenticatorId}/enrollments
Request samples 
Response samples 
application/json
[]
Retrieve an Enrollment
Identity Engine
OAuth 2.0: okta.myAccount.authenticators.read
Retrieves an enrollment by enrollmentId


Request 
path Parameters
authenticatorId
required
string
id of the authenticator


 
 Example:  aut9gnvcjUHIWb37J0g4
enrollmentId
required
string
id of the authenticator enrollment


 
 Example:  ufs2bysphxKODSZKWVCT
Responses 
200
Enrollment


403
Forbidden


404
Not Found


429
Too Many Requests


get/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}
Request samples 
Response samples 
application/json
{}
Update an enrollment
Identity Engine
OAuth 2.0: okta.myAccount.authenticators.manage
Updates an authenticator enrollment by enrollmentId.
The following update operations are allowed:


    

  • Update the enrollment nickname
    • 

  • Remove the enrollment nickname
    • 



Request 
path Parameters
authenticatorId
required
string
id of the authenticator


 
 Example:  aut9gnvcjUHIWb37J0g4
enrollmentId
required
string
id of the authenticator enrollment


 
 Example:  ufs2bysphxKODSZKWVCT
Request Body schema: application/merge-patch+json;okta-version=1.0.0
nickname
string
 
Responses 
200
OK


401
Unauthorized


403
Access Denied


404
Resource Not Found


patch/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}
Request samples 
application/merge-patch+json;okta-version=1.0.0
{
  • "nickname": "Bob's Phone"
}
Response samples 
application/json;okta-version=1.0.0
{
  • "canReset": true,
  • "canUnenroll": true,
  • "created": "string",
  • "id": "string",
  • "lastChallenged": "string",
  • "name": "string",
  • "nickname": "string",
  • "profile": { },
  • "_links": {
    • "self": {
      },
    • "authenticator": {
      },
    • "modify": {
      },
    • "unenroll": {
      }
    }
}