authenticator_enrollments

Creates, updates, deletes, gets or lists an authenticator_enrollments resource.

Overview

Name	authenticator_enrollments
Type	Resource
Id	okta.users.authenticator_enrollments

Fields

The following fields are returned by SELECT queries:

list_authenticator_enrollments

Name	Datatype	Description
id	string	The unique identifier of the authenticator enrollment
name	string	The authenticator display name
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string (date-time)	Timestamp when the authenticator enrollment was created
key	string	A human-readable string that identifies the authenticator
lastUpdated	string (date-time)	Timestamp when the authenticator enrollment was last updated
profile	object	Defines the authenticator specific parameters
status	string	Status of the enrollment
type	string	The type of authenticator

get_authenticator_enrollment

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_authenticator_enrollments	select	subdomain		Lists all authenticator enrollments of the specified user
get_authenticator_enrollment	select	subdomain		Retrieves a user's authenticator enrollment by enrollmentId
create_authenticator_enrollment	insert	userId, subdomain, data__authenticatorId, data__profile		Creates a Phone authenticator enrollment that's automatically activated
create_tac_authenticator_enrollment	insert	userId, subdomain, data__authenticatorId		Creates an auto-activated Temporary access code (TAC) authenticator enrollment
delete_authenticator_enrollment	delete	subdomain		Deletes an existing enrollment for the specified user. The user can enroll the authenticator again.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)
userId	string	ID of an existing Okta user

SELECT examples

list_authenticator_enrollments

Lists all authenticator enrollments of the specified user

SELECT
id,
name,
_links,
created,
key,
lastUpdated,
profile,
status,
type
FROM okta.users.authenticator_enrollments
WHERE subdomain = '{{ subdomain }}' -- required;

get_authenticator_enrollment

Retrieves a user's authenticator enrollment by enrollmentId

SELECT
*
FROM okta.users.authenticator_enrollments
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_authenticator_enrollment

Creates a Phone authenticator enrollment that's automatically activated

INSERT INTO okta.users.authenticator_enrollments (
data__authenticatorId,
data__profile,
userId,
subdomain
)
SELECT 
'{{ authenticatorId }}' --required,
'{{ profile }}' --required,
'{{ userId }}',
'{{ subdomain }}'
;

create_tac_authenticator_enrollment

Creates an auto-activated Temporary access code (TAC) authenticator enrollment

INSERT INTO okta.users.authenticator_enrollments (
data__authenticatorId,
data__profile,
userId,
subdomain
)
SELECT 
'{{ authenticatorId }}' --required,
'{{ profile }}',
'{{ userId }}',
'{{ subdomain }}'
;

Manifest

# Description fields are for documentation purposes
- name: authenticator_enrollments
  props:
    - name: userId
      value: string
      description: Required parameter for the authenticator_enrollments resource.
    - name: subdomain
      value: string
      description: Required parameter for the authenticator_enrollments resource.
    - name: authenticatorId
      value: string
      description: >
        Unique identifier of the TAC authenticator
        
    - name: profile
      value: object
      description: >
        Defines the authenticator specific parameters
        

DELETE examples

delete_authenticator_enrollment

Deletes an existing enrollment for the specified user. The user can enroll the authenticator again.

DELETE FROM okta.users.authenticator_enrollments
WHERE subdomain = '{{ subdomain }}' --required;