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="2024-09-23T08:35:59.300824-05:00[America/Chicago]", comments="Generator version: 7.8.0") public class AuthenticatorApi extends Object

  • 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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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

    • 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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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

    • 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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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

    • 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

    • listAuthenticatorMethods

      public List<AuthenticatorMethodBase> listAuthenticatorMethods(String authenticatorId) throws ApiException
      List all Methods of an Authenticator Lists all Methods of an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<AuthenticatorMethodBase>
      Throws:
      ApiException - if fails to make API call

    • 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

    • 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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the **Settings** > **Features** page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.
      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

    • getObjectMapper

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