org.openapitools.client.api

Class AuthenticatorApi

java.lang.Object

org.openapitools.client.api.AuthenticatorApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.AuthenticatorApi")
public class AuthenticatorApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthenticatorApi()
AuthenticatorApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Authenticator	activateAuthenticator(String authenticatorId) Activate an Authenticator Activates an authenticator by `authenticatorId`
PagedList	activateAuthenticatorWithPaginationInfo(String authenticatorId) Activate an Authenticator Activates an authenticator by `authenticatorId`
Authenticator	createAuthenticator(Authenticator authenticator, Boolean activate) Create an Authenticator Creates an authenticator.
<T> T	createAuthenticator(Class<?> T, Authenticator authenticator, Boolean activate) Create an Authenticator Creates an authenticator.
PagedList	createAuthenticatorWithPaginationInfo(Authenticator authenticator, Boolean activate) Create an Authenticator Creates an authenticator.
Authenticator	deactivateAuthenticator(String authenticatorId) Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`
PagedList	deactivateAuthenticatorWithPaginationInfo(String authenticatorId) Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`
ApiClient	getApiClient()
Authenticator	getAuthenticator(String authenticatorId) Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`
PagedList	getAuthenticatorWithPaginationInfo(String authenticatorId) Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`
List<Authenticator>	listAuthenticators() List all Authenticators Lists all authenticators
PagedList	listAuthenticatorsWithPaginationInfo() List all Authenticators Lists all authenticators
<T> T	replaceAuthenticator(Class<?> T, String authenticatorId, Authenticator authenticator) Replace an Authenticator Replaces an authenticator
Authenticator	replaceAuthenticator(String authenticatorId, Authenticator authenticator) Replace an Authenticator Replaces an authenticator
PagedList	replaceAuthenticatorWithPaginationInfo(String authenticatorId, Authenticator authenticator) Replace an Authenticator Replaces an authenticator
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatorApi

public AuthenticatorApi()

AuthenticatorApi

@Autowired
public AuthenticatorApi(ApiClient apiClient)

Method Detail

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

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

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

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

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

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

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