Package com.okta.sdk.resource.api

Class UserAuthenticatorEnrollmentsApi

java.lang.Object

com.okta.sdk.resource.api.UserAuthenticatorEnrollmentsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class UserAuthenticatorEnrollmentsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UserAuthenticatorEnrollmentsApi()
UserAuthenticatorEnrollmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthenticatorEnrollment	createAuthenticatorEnrollment(String userId, AuthenticatorEnrollmentCreateRequest authenticator)	Create an auto-activated Phone authenticator enrollment Creates a Phone authenticator enrollment that's automatically activated
AuthenticatorEnrollment	createAuthenticatorEnrollment(String userId, AuthenticatorEnrollmentCreateRequest authenticator, Map<String,String> additionalHeaders)	Create an auto-activated Phone authenticator enrollment Creates a Phone authenticator enrollment that's automatically activated
TacAuthenticatorEnrollment	createTacAuthenticatorEnrollment(String userId, AuthenticatorEnrollmentCreateRequestTac authenticator)	Create an auto-activated TAC authenticator enrollment Creates an auto-activated Temporary access code (TAC) authenticator enrollment
TacAuthenticatorEnrollment	createTacAuthenticatorEnrollment(String userId, AuthenticatorEnrollmentCreateRequestTac authenticator, Map<String,String> additionalHeaders)	Create an auto-activated TAC authenticator enrollment Creates an auto-activated Temporary access code (TAC) authenticator enrollment
void	deleteAuthenticatorEnrollment(String userId, String enrollmentId)	Delete an authenticator enrollment Deletes an existing enrollment for the specified user.
void	deleteAuthenticatorEnrollment(String userId, String enrollmentId, Map<String,String> additionalHeaders)	Delete an authenticator enrollment Deletes an existing enrollment for the specified user.
ApiClient	getApiClient()
AuthenticatorEnrollment	getAuthenticatorEnrollment(String userId, String enrollmentId, List<String> discloseIdentifiers)	Retrieve an authenticator enrollment Retrieves a user's authenticator enrollment by `enrollmentId`
AuthenticatorEnrollment	getAuthenticatorEnrollment(String userId, String enrollmentId, List<String> discloseIdentifiers, Map<String,String> additionalHeaders)	Retrieve an authenticator enrollment Retrieves a user's authenticator enrollment by `enrollmentId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
AuthenticatorEnrollment	listAuthenticatorEnrollments(String userId, List<String> discloseIdentifiers)	List all authenticator enrollments Lists all authenticator enrollments of the specified user
AuthenticatorEnrollment	listAuthenticatorEnrollments(String userId, List<String> discloseIdentifiers, Map<String,String> additionalHeaders)	List all authenticator enrollments Lists all authenticator enrollments of the specified user
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserAuthenticatorEnrollmentsApi

public UserAuthenticatorEnrollmentsApi()

UserAuthenticatorEnrollmentsApi

public UserAuthenticatorEnrollmentsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAuthenticatorEnrollment

public AuthenticatorEnrollment createAuthenticatorEnrollment(String userId,
 AuthenticatorEnrollmentCreateRequest authenticator)
                                                      throws ApiException

Create an auto-activated Phone authenticator enrollment Creates a Phone authenticator enrollment that's automatically activated

Parameters:

userId - ID of an existing Okta user (required)

authenticator - (required)

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

createAuthenticatorEnrollment

public AuthenticatorEnrollment createAuthenticatorEnrollment(String userId,
 AuthenticatorEnrollmentCreateRequest authenticator,
 Map<String,String> additionalHeaders)
                                                      throws ApiException

Create an auto-activated Phone authenticator enrollment Creates a Phone authenticator enrollment that's automatically activated

Parameters:

userId - ID of an existing Okta user (required)

authenticator - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

createTacAuthenticatorEnrollment

public TacAuthenticatorEnrollment createTacAuthenticatorEnrollment(String userId,
 AuthenticatorEnrollmentCreateRequestTac authenticator)
                                                            throws ApiException

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

Parameters:

userId - ID of an existing Okta user (required)

authenticator - (required)

Returns:

TacAuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

createTacAuthenticatorEnrollment

public TacAuthenticatorEnrollment createTacAuthenticatorEnrollment(String userId,
 AuthenticatorEnrollmentCreateRequestTac authenticator,
 Map<String,String> additionalHeaders)
                                                            throws ApiException

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

Parameters:

userId - ID of an existing Okta user (required)

authenticator - (required)

additionalHeaders - additionalHeaders for this call

Returns:

TacAuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

deleteAuthenticatorEnrollment

public void deleteAuthenticatorEnrollment(String userId,
 String enrollmentId)
                                   throws ApiException

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

Parameters:

userId - ID of an existing Okta user (required)

enrollmentId - Unique identifier of an enrollment (required)

Throws:

ApiException - if fails to make API call

deleteAuthenticatorEnrollment

public void deleteAuthenticatorEnrollment(String userId,
 String enrollmentId,
 Map<String,String> additionalHeaders)
                                   throws ApiException

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

Parameters:

userId - ID of an existing Okta user (required)

enrollmentId - Unique identifier of an enrollment (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getAuthenticatorEnrollment

public AuthenticatorEnrollment getAuthenticatorEnrollment(String userId,
 String enrollmentId,
 List<String> discloseIdentifiers)
                                                   throws ApiException

Retrieve an authenticator enrollment Retrieves a user's authenticator enrollment by `enrollmentId`

Parameters:

userId - ID of an existing Okta user (required)

enrollmentId - Unique identifier of an enrollment (required)

discloseIdentifiers - 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. (optional

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

getAuthenticatorEnrollment

public AuthenticatorEnrollment getAuthenticatorEnrollment(String userId,
 String enrollmentId,
 List<String> discloseIdentifiers,
 Map<String,String> additionalHeaders)
                                                   throws ApiException

Retrieve an authenticator enrollment Retrieves a user's authenticator enrollment by `enrollmentId`

Parameters:

userId - ID of an existing Okta user (required)

enrollmentId - Unique identifier of an enrollment (required)

discloseIdentifiers - 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. (optional

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

listAuthenticatorEnrollments

public AuthenticatorEnrollment listAuthenticatorEnrollments(String userId,
 List<String> discloseIdentifiers)
                                                     throws ApiException

List all authenticator enrollments Lists all authenticator enrollments of the specified user

Parameters:

userId - ID of an existing Okta user (required)

discloseIdentifiers - 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. (optional

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

listAuthenticatorEnrollments

public AuthenticatorEnrollment listAuthenticatorEnrollments(String userId,
 List<String> discloseIdentifiers,
 Map<String,String> additionalHeaders)
                                                     throws ApiException

List all authenticator enrollments Lists all authenticator enrollments of the specified user

Parameters:

userId - ID of an existing Okta user (required)

discloseIdentifiers - 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. (optional

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorEnrollment

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()