OKokta
UserFactor

Enroll Factor

Enrolls a user with a supported factor.

post/api/v1/users/{userId}/factors

Request

  • Base URL
    https://your-subdomain.okta.com
  • Auth
    API key in header Authorization

Path parameters

userIdstring required

Query parameters

updatePhoneboolean
templateIdstring

id of SMS template (only for SMS factor)

tokenLifetimeSecondsinteger
activateboolean

Request body

_embeddedobject
_linksobject
createdstring date-time
factorType'call' | 'email' | 'hotp' | 'push' | 'question' | 'signed_nonce' | 'sms' | 'token:hardware' | 'token:hotp' | 'token:software:totp' | 'token' | 'u2f' | 'web' | 'webauthn'
idstring
lastUpdatedstring date-time
provider'OKTA' | 'RSA' | 'FIDO' | 'GOOGLE' | 'SYMANTEC' | 'DUO' | 'YUBICO' | 'CUSTOM' | 'APPLE'
status'PENDING_ACTIVATION' | 'ACTIVE' | 'INACTIVE' | 'NOT_SETUP' | 'ENROLLED' | 'DISABLED' | 'EXPIRED'

Response

Success

_embeddedobject
_linksobject
createdstring date-time
factorType'call' | 'email' | 'hotp' | 'push' | 'question' | 'signed_nonce' | 'sms' | 'token:hardware' | 'token:hotp' | 'token:software:totp' | 'token' | 'u2f' | 'web' | 'webauthn'
idstring
lastUpdatedstring date-time
provider'OKTA' | 'RSA' | 'FIDO' | 'GOOGLE' | 'SYMANTEC' | 'DUO' | 'YUBICO' | 'CUSTOM' | 'APPLE'
status'PENDING_ACTIVATION' | 'ACTIVE' | 'INACTIVE' | 'NOT_SETUP' | 'ENROLLED' | 'DISABLED' | 'EXPIRED'

Changes

No recorded changes to this operation across all 1 revision of this API.