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:

get_authenticator_enrollment

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 (app, email, federated, password, phone, security_key, security_question, tac)

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 (app, email, federated, password, phone, security_key, security_question, tac)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_authenticator_enrollment	select	userId, enrollmentId, subdomain	discloseIdentifiers	Retrieves a user's authenticator enrollment by enrollmentId
list_authenticator_enrollments	select	userId, subdomain	discloseIdentifiers	Lists all authenticator enrollments of the specified user
create_authenticator_enrollment	insert	userId, subdomain, authenticatorId, profile		Creates a Phone authenticator enrollment that's automatically activated
create_tac_authenticator_enrollment	insert	userId, subdomain, authenticatorId		Creates an auto-activated Temporary access code (TAC) authenticator enrollment
delete_authenticator_enrollment	delete	userId, enrollmentId, 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
enrollmentId	string	Unique identifier of an enrollment
subdomain	string	(default: my-org)
userId	string	ID of an existing Okta user
discloseIdentifiers	array	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.

SELECT examples

get_authenticator_enrollment

Retrieves a user's authenticator enrollment by enrollmentId

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

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 userId = '{{ userId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND discloseIdentifiers = '{{ discloseIdentifiers }}'
;

INSERT examples

create_authenticator_enrollment

Creates a Phone authenticator enrollment that's automatically activated

INSERT INTO okta.users.authenticator_enrollments (
authenticatorId,
profile,
userId,
subdomain
)
SELECT 
'{{ authenticatorId }}' /* required */,
'{{ profile }}' /* required */,
'{{ userId }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
created,
key,
lastUpdated,
profile,
status,
type
;

create_tac_authenticator_enrollment

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

INSERT INTO okta.users.authenticator_enrollments (
authenticatorId,
profile,
userId,
subdomain
)
SELECT 
'{{ authenticatorId }}' /* required */,
'{{ profile }}',
'{{ userId }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
created,
key,
lastUpdated,
nickname,
profile,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: authenticator_enrollments
props:
  - name: userId
    value: "{{ userId }}"
    description: Required parameter for the authenticator_enrollments resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the authenticator_enrollments resource.
  - name: authenticatorId
    value: "{{ authenticatorId }}"
    description: |
      Unique identifier of the TAC authenticator
  - name: profile
    description: |
      Defines the authenticator specific parameters
    value:
      multiUse: {{ multiUse }}
      ttl: "{{ ttl }}"

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 userId = '{{ userId }}' --required
AND enrollmentId = '{{ enrollmentId }}' --required
AND subdomain = '{{ subdomain }}' --required
;