Package com.okta.sdk.resource.api

Class AuthenticatorApi

java.lang.Object

com.okta.sdk.resource.api.AuthenticatorApi

@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 AuthenticatorApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuthenticatorApi()
AuthenticatorApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthenticatorBase	activateAuthenticator(String authenticatorId)	Activate an authenticator Activates an authenticator by `authenticatorId`
AuthenticatorBase	activateAuthenticator(String authenticatorId, Map<String,String> additionalHeaders)	Activate an authenticator Activates an authenticator by `authenticatorId`
AuthenticatorMethodBase	activateAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType)	Activate an authenticator method Activates a method for an authenticator identified by `authenticatorId` and `methodType`
AuthenticatorMethodBase	activateAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, Map<String,String> additionalHeaders)	Activate an authenticator method Activates a method for an authenticator identified by `authenticatorId` and `methodType`
AuthenticatorBase	createAuthenticator(AuthenticatorBase authenticator, Boolean activate)	Create an authenticator Creates an authenticator
AuthenticatorBase	createAuthenticator(AuthenticatorBase authenticator, Boolean activate, Map<String,String> additionalHeaders)	Create an authenticator Creates an authenticator
CustomAAGUIDResponseObject	createCustomAAGUID(String authenticatorId, CustomAAGUIDCreateRequestObject customAAGUIDCreateRequestObject)	Create a custom AAGUID Creates a custom AAGUID for the WebAuthn authenticator
CustomAAGUIDResponseObject	createCustomAAGUID(String authenticatorId, CustomAAGUIDCreateRequestObject customAAGUIDCreateRequestObject, Map<String,String> additionalHeaders)	Create a custom AAGUID Creates a custom AAGUID for the WebAuthn authenticator
AuthenticatorBase	deactivateAuthenticator(String authenticatorId)	Deactivate an authenticator Deactivates an authenticator by `authenticatorId`
AuthenticatorBase	deactivateAuthenticator(String authenticatorId, Map<String,String> additionalHeaders)	Deactivate an authenticator Deactivates an authenticator by `authenticatorId`
AuthenticatorMethodBase	deactivateAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType)	Deactivate an authenticator method Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`
AuthenticatorMethodBase	deactivateAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, Map<String,String> additionalHeaders)	Deactivate an authenticator method Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`
void	deleteCustomAAGUID(String authenticatorId, String aaguid)	Delete a custom AAGUID Deletes a custom AAGUID You can only delete custom AAGUIDs that an admin has created.
void	deleteCustomAAGUID(String authenticatorId, String aaguid, Map<String,String> additionalHeaders)	Delete a custom AAGUID Deletes a custom AAGUID You can only delete custom AAGUIDs that an admin has created.
ApiClient	getApiClient()
AuthenticatorBase	getAuthenticator(String authenticatorId)	Retrieve an authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`
AuthenticatorBase	getAuthenticator(String authenticatorId, Map<String,String> additionalHeaders)	Retrieve an authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`
AuthenticatorMethodBase	getAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType)	Retrieve an authenticator method Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`
AuthenticatorMethodBase	getAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, Map<String,String> additionalHeaders)	Retrieve an authenticator method Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`
CustomAAGUIDResponseObject	getCustomAAGUID(String authenticatorId, String aaguid)	Retrieve a custom AAGUID Retrieves a custom AAGUID
CustomAAGUIDResponseObject	getCustomAAGUID(String authenticatorId, String aaguid, Map<String,String> additionalHeaders)	Retrieve a custom AAGUID Retrieves a custom AAGUID
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<WellKnownAppAuthenticatorConfiguration>	getWellKnownAppAuthenticatorConfiguration(String oauthClientId)	Retrieve the well-known app authenticator configuration Retrieves the well-known app authenticator configuration.
List<WellKnownAppAuthenticatorConfiguration>	getWellKnownAppAuthenticatorConfiguration(String oauthClientId, Map<String,String> additionalHeaders)	Retrieve the well-known app authenticator configuration Retrieves the well-known app authenticator configuration.
Iterable<WellKnownAppAuthenticatorConfiguration>	getWellKnownAppAuthenticatorConfigurationPaged(String oauthClientId)	Retrieve the well-known app authenticator configuration (Paginated) Retrieves the well-known app authenticator configuration.
Iterable<WellKnownAppAuthenticatorConfiguration>	getWellKnownAppAuthenticatorConfigurationPaged(String oauthClientId, Map<String,String> additionalHeaders)	Retrieve the well-known app authenticator configuration (Paginated with additional headers) Retrieves the well-known app authenticator configuration.
List<CustomAAGUIDResponseObject>	listAllCustomAAGUIDs(String authenticatorId)	List all custom AAGUIDs Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
List<CustomAAGUIDResponseObject>	listAllCustomAAGUIDs(String authenticatorId, Map<String,String> additionalHeaders)	List all custom AAGUIDs Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
Iterable<CustomAAGUIDResponseObject>	listAllCustomAAGUIDsPaged(String authenticatorId)	List all custom AAGUIDs (Paginated) Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
Iterable<CustomAAGUIDResponseObject>	listAllCustomAAGUIDsPaged(String authenticatorId, Map<String,String> additionalHeaders)	List all custom AAGUIDs (Paginated with additional headers) Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
List<AuthenticatorMethodBase>	listAuthenticatorMethods(String authenticatorId)	List all methods of an authenticator Lists all methods of an authenticator identified by `authenticatorId`
List<AuthenticatorMethodBase>	listAuthenticatorMethods(String authenticatorId, Map<String,String> additionalHeaders)	List all methods of an authenticator Lists all methods of an authenticator identified by `authenticatorId`
Iterable<AuthenticatorMethodBase>	listAuthenticatorMethodsPaged(String authenticatorId)	List all methods of an authenticator (Paginated) Lists all methods of an authenticator identified by `authenticatorId` This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<AuthenticatorMethodBase>	listAuthenticatorMethodsPaged(String authenticatorId, Map<String,String> additionalHeaders)	List all methods of an authenticator (Paginated with additional headers) Lists all methods of an authenticator identified by `authenticatorId` This method returns a lazy, paginated iterable that automatically handles pagination.
List<AuthenticatorBase>	listAuthenticators()	List all authenticators Lists all authenticators
List<AuthenticatorBase>	listAuthenticators(Map<String,String> additionalHeaders)	List all authenticators Lists all authenticators
Iterable<AuthenticatorBase>	listAuthenticatorsPaged()	List all authenticators (Paginated) Lists all authenticators This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<AuthenticatorBase>	listAuthenticatorsPaged(Map<String,String> additionalHeaders)	List all authenticators (Paginated with additional headers) Lists all authenticators This method returns a lazy, paginated iterable that automatically handles pagination.
AuthenticatorBase	replaceAuthenticator(String authenticatorId, AuthenticatorBase authenticator)	Replace an authenticator Replaces the properties for an authenticator identified by `authenticatorId`
AuthenticatorBase	replaceAuthenticator(String authenticatorId, AuthenticatorBase authenticator, Map<String,String> additionalHeaders)	Replace an authenticator Replaces the properties for an authenticator identified by `authenticatorId`
AuthenticatorMethodBase	replaceAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase)	Replace an authenticator method Replaces a method of `methodType` for an authenticator identified by `authenticatorId`
AuthenticatorMethodBase	replaceAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase, Map<String,String> additionalHeaders)	Replace an authenticator method Replaces a method of `methodType` for an authenticator identified by `authenticatorId`
CustomAAGUIDResponseObject	replaceCustomAAGUID(String authenticatorId, String aaguid, CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject)	Replace a custom AAGUID Replaces a custom AAGUID for the specified WebAuthn authenticator
CustomAAGUIDResponseObject	replaceCustomAAGUID(String authenticatorId, String aaguid, CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject, Map<String,String> additionalHeaders)	Replace a custom AAGUID Replaces a custom AAGUID for the specified WebAuthn authenticator
void	setApiClient(ApiClient apiClient)
CustomAAGUIDResponseObject	updateCustomAAGUID(String authenticatorId, String aaguid, CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject)	Update a custom AAGUID Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID
CustomAAGUIDResponseObject	updateCustomAAGUID(String authenticatorId, String aaguid, CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject, Map<String,String> additionalHeaders)	Update a custom AAGUID Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID
void	verifyRpIdDomain(String authenticatorId, AuthenticatorMethodTypeWebAuthn webAuthnMethodType)	Verify a Relying Party ID domain Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified WebAuthn authenticator and the specific `webauthn` authenticator method
void	verifyRpIdDomain(String authenticatorId, AuthenticatorMethodTypeWebAuthn webAuthnMethodType, Map<String,String> additionalHeaders)	Verify a Relying Party ID domain Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified WebAuthn authenticator and the specific `webauthn` authenticator method

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticatorApi

public AuthenticatorApi()

AuthenticatorApi

public AuthenticatorApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateAuthenticator

public AuthenticatorBase activateAuthenticator(String authenticatorId)
                                        throws ApiException

Activate an authenticator Activates an authenticator by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

activateAuthenticator

public AuthenticatorBase activateAuthenticator(String authenticatorId,
 Map<String,String> additionalHeaders)
                                        throws ApiException

Activate an authenticator Activates an authenticator by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

activateAuthenticatorMethod

public AuthenticatorMethodBase activateAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType)
                                                    throws ApiException

Activate an authenticator method Activates a method for an authenticator identified by `authenticatorId` and `methodType`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

activateAuthenticatorMethod

public AuthenticatorMethodBase activateAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType,
 Map<String,String> additionalHeaders)
                                                    throws ApiException

Activate an authenticator method Activates a method for an authenticator identified by `authenticatorId` and `methodType`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

createAuthenticator

public AuthenticatorBase createAuthenticator(AuthenticatorBase authenticator,
 Boolean activate)
                                      throws ApiException

Create an authenticator Creates an authenticator

Parameters:

authenticator - (required)

activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to true)

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

createAuthenticator

public AuthenticatorBase createAuthenticator(AuthenticatorBase authenticator,
 Boolean activate,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Create an authenticator Creates an authenticator

Parameters:

authenticator - (required)

activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to true)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

createCustomAAGUID

public CustomAAGUIDResponseObject createCustomAAGUID(String authenticatorId,
 CustomAAGUIDCreateRequestObject customAAGUIDCreateRequestObject)
                                              throws ApiException

Create a custom AAGUID Creates a custom AAGUID for the WebAuthn authenticator

Parameters:

authenticatorId - `id` of the authenticator (required)

customAAGUIDCreateRequestObject - (optional)

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

createCustomAAGUID

public CustomAAGUIDResponseObject createCustomAAGUID(String authenticatorId,
 CustomAAGUIDCreateRequestObject customAAGUIDCreateRequestObject,
 Map<String,String> additionalHeaders)
                                              throws ApiException

Create a custom AAGUID Creates a custom AAGUID for the WebAuthn authenticator

Parameters:

authenticatorId - `id` of the authenticator (required)

customAAGUIDCreateRequestObject - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

deactivateAuthenticator

public AuthenticatorBase deactivateAuthenticator(String authenticatorId)
                                          throws ApiException

Deactivate an authenticator Deactivates an authenticator by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

deactivateAuthenticator

public AuthenticatorBase deactivateAuthenticator(String authenticatorId,
 Map<String,String> additionalHeaders)
                                          throws ApiException

Deactivate an authenticator Deactivates an authenticator by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

deactivateAuthenticatorMethod

public AuthenticatorMethodBase deactivateAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType)
                                                      throws ApiException

Deactivate an authenticator method Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

deactivateAuthenticatorMethod

public AuthenticatorMethodBase deactivateAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType,
 Map<String,String> additionalHeaders)
                                                      throws ApiException

Deactivate an authenticator method Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

deleteCustomAAGUID

public void deleteCustomAAGUID(String authenticatorId,
 String aaguid)
                        throws ApiException

Delete a custom AAGUID Deletes a custom AAGUID You can only delete custom AAGUIDs that an admin has created.

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

Throws:

ApiException - if fails to make API call

deleteCustomAAGUID

public void deleteCustomAAGUID(String authenticatorId,
 String aaguid,
 Map<String,String> additionalHeaders)
                        throws ApiException

Delete a custom AAGUID Deletes a custom AAGUID You can only delete custom AAGUIDs that an admin has created.

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getAuthenticator

public AuthenticatorBase getAuthenticator(String authenticatorId)
                                   throws ApiException

Retrieve an authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

getAuthenticator

public AuthenticatorBase getAuthenticator(String authenticatorId,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Retrieve an authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

getAuthenticatorMethod

public AuthenticatorMethodBase getAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType)
                                               throws ApiException

Retrieve an authenticator method Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

getAuthenticatorMethod

public AuthenticatorMethodBase getAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Retrieve an authenticator method Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

getCustomAAGUID

public CustomAAGUIDResponseObject getCustomAAGUID(String authenticatorId,
 String aaguid)
                                           throws ApiException

Retrieve a custom AAGUID Retrieves a custom AAGUID

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

getCustomAAGUID

public CustomAAGUIDResponseObject getCustomAAGUID(String authenticatorId,
 String aaguid,
 Map<String,String> additionalHeaders)
                                           throws ApiException

Retrieve a custom AAGUID Retrieves a custom AAGUID

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

additionalHeaders - additionalHeaders for this call

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

getWellKnownAppAuthenticatorConfiguration

public List<WellKnownAppAuthenticatorConfiguration> getWellKnownAppAuthenticatorConfiguration(String oauthClientId)
                                                                                       throws ApiException

Retrieve the well-known app authenticator configuration Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details.

Parameters:

oauthClientId - Filters app authenticator configurations by `oauthClientId` (required)

Returns:

List<WellKnownAppAuthenticatorConfiguration>

Throws:

ApiException - if fails to make API call

getWellKnownAppAuthenticatorConfiguration

public List<WellKnownAppAuthenticatorConfiguration> getWellKnownAppAuthenticatorConfiguration(String oauthClientId,
 Map<String,String> additionalHeaders)
                                                                                       throws ApiException

Retrieve the well-known app authenticator configuration Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details.

Parameters:

oauthClientId - Filters app authenticator configurations by `oauthClientId` (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<WellKnownAppAuthenticatorConfiguration>

Throws:

ApiException - if fails to make API call

getWellKnownAppAuthenticatorConfigurationPaged

public Iterable<WellKnownAppAuthenticatorConfiguration> getWellKnownAppAuthenticatorConfigurationPaged(String oauthClientId)

Retrieve the well-known app authenticator configuration (Paginated) Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

oauthClientId - Filters app authenticator configurations by `oauthClientId` (required)

Returns:

Iterable<WellKnownAppAuthenticatorConfiguration> lazy iterable over all pages

getWellKnownAppAuthenticatorConfigurationPaged

public Iterable<WellKnownAppAuthenticatorConfiguration> getWellKnownAppAuthenticatorConfigurationPaged(String oauthClientId,
 Map<String,String> additionalHeaders)

Retrieve the well-known app authenticator configuration (Paginated with additional headers) Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

oauthClientId - Filters app authenticator configurations by `oauthClientId` (required)

additionalHeaders - additional headers for this call

Returns:

Iterable<WellKnownAppAuthenticatorConfiguration> lazy iterable over all pages

listAllCustomAAGUIDs

public List<CustomAAGUIDResponseObject> listAllCustomAAGUIDs(String authenticatorId)
                                                      throws ApiException

List all custom AAGUIDs Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

List<CustomAAGUIDResponseObject>

Throws:

ApiException - if fails to make API call

listAllCustomAAGUIDs

public List<CustomAAGUIDResponseObject> listAllCustomAAGUIDs(String authenticatorId,
 Map<String,String> additionalHeaders)
                                                      throws ApiException

List all custom AAGUIDs Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<CustomAAGUIDResponseObject>

Throws:

ApiException - if fails to make API call

listAllCustomAAGUIDsPaged

public Iterable<CustomAAGUIDResponseObject> listAllCustomAAGUIDsPaged(String authenticatorId)

List all custom AAGUIDs (Paginated) Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

Iterable<CustomAAGUIDResponseObject> lazy iterable over all pages

listAllCustomAAGUIDsPaged

public Iterable<CustomAAGUIDResponseObject> listAllCustomAAGUIDsPaged(String authenticatorId,
 Map<String,String> additionalHeaders)

List all custom AAGUIDs (Paginated with additional headers) Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additional headers for this call

Returns:

Iterable<CustomAAGUIDResponseObject> lazy iterable over all pages

listAuthenticatorMethods

public List<AuthenticatorMethodBase> listAuthenticatorMethods(String authenticatorId)
                                                       throws ApiException

List all methods of an authenticator Lists all methods of an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

List<AuthenticatorMethodBase>

Throws:

ApiException - if fails to make API call

listAuthenticatorMethods

public List<AuthenticatorMethodBase> listAuthenticatorMethods(String authenticatorId,
 Map<String,String> additionalHeaders)
                                                       throws ApiException

List all methods of an authenticator Lists all methods of an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<AuthenticatorMethodBase>

Throws:

ApiException - if fails to make API call

listAuthenticatorMethodsPaged

public Iterable<AuthenticatorMethodBase> listAuthenticatorMethodsPaged(String authenticatorId)

List all methods of an authenticator (Paginated) Lists all methods of an authenticator identified by `authenticatorId` This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

authenticatorId - `id` of the authenticator (required)

Returns:

Iterable<AuthenticatorMethodBase> lazy iterable over all pages

listAuthenticatorMethodsPaged

public Iterable<AuthenticatorMethodBase> listAuthenticatorMethodsPaged(String authenticatorId,
 Map<String,String> additionalHeaders)

List all methods of an authenticator (Paginated with additional headers) Lists all methods of an authenticator identified by `authenticatorId` This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

authenticatorId - `id` of the authenticator (required)

additionalHeaders - additional headers for this call

Returns:

Iterable<AuthenticatorMethodBase> lazy iterable over all pages

listAuthenticators

public List<AuthenticatorBase> listAuthenticators()
                                           throws ApiException

List all authenticators Lists all authenticators

Returns:

List<AuthenticatorBase>

Throws:

ApiException - if fails to make API call

listAuthenticators

public List<AuthenticatorBase> listAuthenticators(Map<String,String> additionalHeaders)
                                           throws ApiException

List all authenticators Lists all authenticators

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<AuthenticatorBase>

Throws:

ApiException - if fails to make API call

listAuthenticatorsPaged

public Iterable<AuthenticatorBase> listAuthenticatorsPaged()

List all authenticators (Paginated) Lists all authenticators This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Returns:

Iterable<AuthenticatorBase> lazy iterable over all pages

listAuthenticatorsPaged

public Iterable<AuthenticatorBase> listAuthenticatorsPaged(Map<String,String> additionalHeaders)

List all authenticators (Paginated with additional headers) Lists all authenticators This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

additionalHeaders - additional headers for this call

Returns:

Iterable<AuthenticatorBase> lazy iterable over all pages

replaceAuthenticator

public AuthenticatorBase replaceAuthenticator(String authenticatorId,
 AuthenticatorBase authenticator)
                                       throws ApiException

Replace an authenticator Replaces the properties for an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

authenticator - (required)

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

replaceAuthenticator

public AuthenticatorBase replaceAuthenticator(String authenticatorId,
 AuthenticatorBase authenticator,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Replace an authenticator Replaces the properties for an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

authenticator - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorBase

Throws:

ApiException - if fails to make API call

replaceAuthenticatorMethod

public AuthenticatorMethodBase replaceAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType,
 AuthenticatorMethodBase authenticatorMethodBase)
                                                   throws ApiException

Replace an authenticator method Replaces a method of `methodType` for an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

authenticatorMethodBase - (optional)

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

replaceAuthenticatorMethod

public AuthenticatorMethodBase replaceAuthenticatorMethod(String authenticatorId,
 AuthenticatorMethodType methodType,
 AuthenticatorMethodBase authenticatorMethodBase,
 Map<String,String> additionalHeaders)
                                                   throws ApiException

Replace an authenticator method Replaces a method of `methodType` for an authenticator identified by `authenticatorId`

Parameters:

authenticatorId - `id` of the authenticator (required)

methodType - Type of authenticator method (required)

authenticatorMethodBase - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticatorMethodBase

Throws:

ApiException - if fails to make API call

replaceCustomAAGUID

public CustomAAGUIDResponseObject replaceCustomAAGUID(String authenticatorId,
 String aaguid,
 CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject)
                                               throws ApiException

Replace a custom AAGUID Replaces a custom AAGUID for the specified WebAuthn authenticator

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

customAAGUIDUpdateRequestObject - (optional)

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

replaceCustomAAGUID

public CustomAAGUIDResponseObject replaceCustomAAGUID(String authenticatorId,
 String aaguid,
 CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Replace a custom AAGUID Replaces a custom AAGUID for the specified WebAuthn authenticator

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

customAAGUIDUpdateRequestObject - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

updateCustomAAGUID

public CustomAAGUIDResponseObject updateCustomAAGUID(String authenticatorId,
 String aaguid,
 CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject)
                                              throws ApiException

Update a custom AAGUID Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

customAAGUIDUpdateRequestObject - (optional)

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

updateCustomAAGUID

public CustomAAGUIDResponseObject updateCustomAAGUID(String authenticatorId,
 String aaguid,
 CustomAAGUIDUpdateRequestObject customAAGUIDUpdateRequestObject,
 Map<String,String> additionalHeaders)
                                              throws ApiException

Update a custom AAGUID Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID

Parameters:

authenticatorId - `id` of the authenticator (required)

aaguid - Unique ID of a custom AAGUID (required)

customAAGUIDUpdateRequestObject - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CustomAAGUIDResponseObject

Throws:

ApiException - if fails to make API call

verifyRpIdDomain

public void verifyRpIdDomain(String authenticatorId,
 AuthenticatorMethodTypeWebAuthn webAuthnMethodType)
                      throws ApiException

Verify a Relying Party ID domain Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified WebAuthn authenticator and the specific `webauthn` authenticator method

Parameters:

authenticatorId - `id` of the authenticator (required)

webAuthnMethodType - Type of authenticator method (required)

Throws:

ApiException - if fails to make API call

verifyRpIdDomain

public void verifyRpIdDomain(String authenticatorId,
 AuthenticatorMethodTypeWebAuthn webAuthnMethodType,
 Map<String,String> additionalHeaders)
                      throws ApiException

Verify a Relying Party ID domain Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified WebAuthn authenticator and the specific `webauthn` authenticator method

Parameters:

authenticatorId - `id` of the authenticator (required)

webAuthnMethodType - Type of authenticator method (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

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