Class AuthenticatorApi

java.lang.Object
com.okta.sdk.resource.api.AuthenticatorApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-17T07:49:15.347219-05:00[America/Chicago]", comments="Generator version: 7.5.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 Authenticator activateAuthenticator(String authenticatorId) throws ApiException
      Activate an Authenticator Activates an authenticator by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      Returns:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • activateAuthenticator

      public Authenticator 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:
      Authenticator
      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 the 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 the authenticator method (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthenticatorMethodBase
      Throws:
      ApiException - if fails to make API call
    • createAuthenticator

      public Authenticator createAuthenticator(Authenticator 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 false)
      Returns:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • createAuthenticator

      public Authenticator createAuthenticator(Authenticator 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 false)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • deactivateAuthenticator

      public Authenticator deactivateAuthenticator(String authenticatorId) throws ApiException
      Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      Returns:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • deactivateAuthenticator

      public Authenticator 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:
      Authenticator
      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 the 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 the authenticator method (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthenticatorMethodBase
      Throws:
      ApiException - if fails to make API call
    • getAuthenticator

      public Authenticator 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:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • getAuthenticator

      public Authenticator 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:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • getAuthenticatorMethod

      public AuthenticatorMethodBase getAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType) throws ApiException
      Retrieve a Method Retrieves a Method identified by `methodType` of an Authenticator identified by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      methodType - Type of the 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 a Method Retrieves a Method identified by `methodType` of an Authenticator identified by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      methodType - Type of the 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, which includes an app authenticator's settings, supported methods and various other configuration 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, which includes an app authenticator's settings, supported methods and various other configuration 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`
      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
    • listAuthenticators

      public List<Authenticator> listAuthenticators() throws ApiException
      List all Authenticators Lists all authenticators
      Returns:
      List<Authenticator>
      Throws:
      ApiException - if fails to make API call
    • listAuthenticators

      public List<Authenticator> listAuthenticators(Map<String,String> additionalHeaders) throws ApiException
      List all Authenticators Lists all authenticators
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Authenticator>
      Throws:
      ApiException - if fails to make API call
    • replaceAuthenticator

      public Authenticator replaceAuthenticator(String authenticatorId, Authenticator 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:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • replaceAuthenticator

      public Authenticator replaceAuthenticator(String authenticatorId, Authenticator 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:
      Authenticator
      Throws:
      ApiException - if fails to make API call
    • replaceAuthenticatorMethod

      public AuthenticatorMethodBase replaceAuthenticatorMethod(String authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase) throws ApiException
      Replace a Method Replaces a Method of `methodType` for an Authenticator identified by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      methodType - Type of the 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 a Method Replaces a Method of `methodType` for an Authenticator identified by `authenticatorId`
      Parameters:
      authenticatorId - `id` of the Authenticator (required)
      methodType - Type of the 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()