Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Path Parameters

id
string
required

Global id of the authenticator enrollment.

Response

The authenticator enrollment.

An Oleria AuthenticatorEnrollment object represents a specific account's enrollment in an Oleria Authenticator, recording enrolled authentication methods, enrollment lifecycle, and optional device binding

id
string
required

An identifier (unique to the integrated or assigned application) of any object or entity represented in the Oleria system as well as any relationship or connection among entities when they are represented in Oleria. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. The full list of Oleria objects or entities is defined by the object-type enumeration, and the full list of relationships or connections is defined by the relationship-type enumeration

Minimum string length: 1
accountKey
string
required

The freeform string used by the authenticator provider to identify the enrolled account. Used by the platform to correlate this enrollment to an Account by matching against Account.alias, Account.email, or Account.alternateEmails via the authenticationKeys linkage.

authenticationMethods
object[]
required

The authentication methods enrolled for this enrollment. Narrows the methods available on the parent Authenticator to those specifically active for this account enrollment.

enrollmentStatus
enum<string>
required

The lifecycle status of an AuthenticatorEnrollment. Active indicates a fully enrolled and usable enrollment. Pending indicates enrollment initiated but not yet completed (e.g., device registration required). Revoked indicates the enrollment has been explicitly revoked. Suspended indicates the enrollment is temporarily inactive.

Available options:
Active,
Pending,
Revoked,
Suspended
enrolledAt
string<date-time>
required

Timestamp when the enrollment was created

objectMetadata
object
required

The ObjectMetadata structure defines metadata that applies to every object and relationship, and is usually managed by the system that receives the data

globalId
string
required
oleriaObjectMetadata
object
required

object metadata supersets object metadata with platform enrichment provenance — the enrichment version and the time the record was generated

revokedAt
string<date-time>

Timestamp when the enrollment was revoked (if applicable)

deviceInfo
object

Device binding information for an AuthenticatorEnrollment. Present when the authenticator requires a specific physical device (e.g., device-bound biometric or hardware security key).

sorPrimaryStewardEmail
string