Class AuthenticatorApi

java.lang.Object
org.openapitools.client.api.AuthenticatorApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-04-19T09:13:44.263607-05:00[America/Chicago]") @Component("org.openapitools.client.api.AuthenticatorApi") public class AuthenticatorApi extends Object
  • Constructor Details

    • AuthenticatorApi

      public AuthenticatorApi()
    • AuthenticatorApi

      @Autowired public AuthenticatorApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • activateAuthenticator

      public Authenticator activateAuthenticator(String authenticatorId) throws org.springframework.web.client.RestClientException
      Activate an Authenticator Activates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      Authenticator
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • activateAuthenticatorWithHttpInfo

      public org.springframework.http.ResponseEntity<Authenticator> activateAuthenticatorWithHttpInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Activate an Authenticator Activates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • activateAuthenticatorWithPaginationInfo

      public PagedList activateAuthenticatorWithPaginationInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Activate an Authenticator Activates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • createAuthenticator

      public Authenticator createAuthenticator(Authenticator authenticator, Boolean activate) throws org.springframework.web.client.RestClientException
      Create an Authenticator Creates an authenticator. You can use this operation as part of the \"Create a custom authenticator\" flow. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).

      200 - OK

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      authenticator - (required)
      activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to false)
      Returns:
      Authenticator
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • createAuthenticator

      public <T> T createAuthenticator(Class<?> T, Authenticator authenticator, Boolean activate) throws org.springframework.web.client.RestClientException
      Create an Authenticator Creates an authenticator. You can use this operation as part of the \"Create a custom authenticator\" flow. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).

      200 - OK

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      authenticator - (required)
      activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to false)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • createAuthenticatorWithHttpInfo

      public org.springframework.http.ResponseEntity<Authenticator> createAuthenticatorWithHttpInfo(Authenticator authenticator, Boolean activate) throws org.springframework.web.client.RestClientException
      Create an Authenticator Creates an authenticator. You can use this operation as part of the \"Create a custom authenticator\" flow. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).

      200 - OK

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      authenticator - (required)
      activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to false)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • createAuthenticatorWithPaginationInfo

      public PagedList createAuthenticatorWithPaginationInfo(Authenticator authenticator, Boolean activate) throws org.springframework.web.client.RestClientException
      Create an Authenticator Creates an authenticator. You can use this operation as part of the \"Create a custom authenticator\" flow. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).

      200 - OK

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      authenticator - (required)
      activate - Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional, default to false)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deactivateAuthenticator

      public Authenticator deactivateAuthenticator(String authenticatorId) throws org.springframework.web.client.RestClientException
      Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      Authenticator
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deactivateAuthenticatorWithHttpInfo

      public org.springframework.http.ResponseEntity<Authenticator> deactivateAuthenticatorWithHttpInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deactivateAuthenticatorWithPaginationInfo

      public PagedList deactivateAuthenticatorWithPaginationInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • getAuthenticator

      public Authenticator getAuthenticator(String authenticatorId) throws org.springframework.web.client.RestClientException
      Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      Authenticator
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • getAuthenticatorWithHttpInfo

      public org.springframework.http.ResponseEntity<Authenticator> getAuthenticatorWithHttpInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • getAuthenticatorWithPaginationInfo

      public PagedList getAuthenticatorWithPaginationInfo(String authenticatorId) throws org.springframework.web.client.RestClientException
      Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • listAuthenticators

      public List<Authenticator> listAuthenticators() throws org.springframework.web.client.RestClientException
      List all Authenticators Lists all authenticators

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      Returns:
      List<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • listAuthenticatorsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<Authenticator>> listAuthenticatorsWithHttpInfo() throws org.springframework.web.client.RestClientException
      List all Authenticators Lists all authenticators

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      Returns:
      ResponseEntity<List<Authenticator>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • listAuthenticatorsWithPaginationInfo

      public PagedList listAuthenticatorsWithPaginationInfo() throws org.springframework.web.client.RestClientException
      List all Authenticators Lists all authenticators

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      Returns:
      ResponseEntity<List<Authenticator>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • replaceAuthenticator

      public Authenticator replaceAuthenticator(String authenticatorId, Authenticator authenticator) throws org.springframework.web.client.RestClientException
      Replace an Authenticator Replaces an authenticator

      200 - OK

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      authenticator - (required)
      Returns:
      Authenticator
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • replaceAuthenticator

      public <T> T replaceAuthenticator(Class<?> T, String authenticatorId, Authenticator authenticator) throws org.springframework.web.client.RestClientException
      Replace an Authenticator Replaces an authenticator

      200 - OK

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      authenticatorId - (required)
      authenticator - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • replaceAuthenticatorWithHttpInfo

      public org.springframework.http.ResponseEntity<Authenticator> replaceAuthenticatorWithHttpInfo(String authenticatorId, Authenticator authenticator) throws org.springframework.web.client.RestClientException
      Replace an Authenticator Replaces an authenticator

      200 - OK

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      authenticator - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • replaceAuthenticatorWithPaginationInfo

      public PagedList replaceAuthenticatorWithPaginationInfo(String authenticatorId, Authenticator authenticator) throws org.springframework.web.client.RestClientException
      Replace an Authenticator Replaces an authenticator

      200 - OK

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      authenticatorId - (required)
      authenticator - (required)
      Returns:
      ResponseEntity<Authenticator>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API