Package com.okta.sdk.resource.api

Class ApplicationSsoCredentialOAuth2ClientAuthApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationSsoCredentialOAuth2ClientAuthApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.0") public class ApplicationSsoCredentialOAuth2ClientAuthApi extends Object

  • Constructor Details

    • ApplicationSsoCredentialOAuth2ClientAuthApi

      public ApplicationSsoCredentialOAuth2ClientAuthApi()

    • ApplicationSsoCredentialOAuth2ClientAuthApi

      public ApplicationSsoCredentialOAuth2ClientAuthApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateOAuth2ClientJsonWebKey

      public OAuth2ClientJsonWebKey activateOAuth2ClientJsonWebKey(String appId, String keyId) throws ApiException
      Activate an OAuth 2.0 Client JSON Web Key Activates an OAuth 2.0 Client JSON Web Key by `keyId`
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • activateOAuth2ClientJsonWebKey

      public OAuth2ClientJsonWebKey activateOAuth2ClientJsonWebKey(String appId, String keyId, Map<String,String> additionalHeaders) throws ApiException
      Activate an OAuth 2.0 Client JSON Web Key Activates an OAuth 2.0 Client JSON Web Key by `keyId`
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • activateOAuth2ClientSecret

      public OAuth2ClientSecret activateOAuth2ClientSecret(String appId, String secretId) throws ApiException
      Activate an OAuth 2.0 Client Secret Activates an OAuth 2.0 Client Secret by `secretId`
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • activateOAuth2ClientSecret

      public OAuth2ClientSecret activateOAuth2ClientSecret(String appId, String secretId, Map<String,String> additionalHeaders) throws ApiException
      Activate an OAuth 2.0 Client Secret Activates an OAuth 2.0 Client Secret by `secretId`
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • addJwk

      public OAuth2ClientJsonWebKey addJwk(String appId, OAuth2ClientJsonWebKeyRequestBody oauth2ClientJsonWebKeyRequestBody) throws ApiException
      Add a JSON Web Key Adds a new JSON Web Key to the client’s JSON Web Keys. > **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. This is also consistent with how the [Dynamic Client Registration](/openapi/okta-oauth/oauth/tag/Client/) or [Applications](/openapi/okta-management/management/tag/Application/) APIs behave, as they don't allow the creation of multiple keys without `kids`. Use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) or the [Replace a Client Application](/openapi/okta-oauth/oauth/tag/Client/#tag/Client/operation/replaceClient) operation to update the JWKS or [Delete an OAuth 2.0 Client JSON Web Key](/openapi/okta-management/management/tag/ApplicationSSOCredentialOAuth2ClientAuth/#tag/ApplicationSSOCredentialOAuth2ClientAuth/operation/deletejwk) and re-add the key with a `kid`.
      Parameters:
      appId - Application ID (required)
      oauth2ClientJsonWebKeyRequestBody - (required)
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • addJwk

      public OAuth2ClientJsonWebKey addJwk(String appId, OAuth2ClientJsonWebKeyRequestBody oauth2ClientJsonWebKeyRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Add a JSON Web Key Adds a new JSON Web Key to the client’s JSON Web Keys. > **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. This is also consistent with how the [Dynamic Client Registration](/openapi/okta-oauth/oauth/tag/Client/) or [Applications](/openapi/okta-management/management/tag/Application/) APIs behave, as they don't allow the creation of multiple keys without `kids`. Use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) or the [Replace a Client Application](/openapi/okta-oauth/oauth/tag/Client/#tag/Client/operation/replaceClient) operation to update the JWKS or [Delete an OAuth 2.0 Client JSON Web Key](/openapi/okta-management/management/tag/ApplicationSSOCredentialOAuth2ClientAuth/#tag/ApplicationSSOCredentialOAuth2ClientAuth/operation/deletejwk) and re-add the key with a `kid`.
      Parameters:
      appId - Application ID (required)
      oauth2ClientJsonWebKeyRequestBody - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • createOAuth2ClientSecret

      public OAuth2ClientSecret createOAuth2ClientSecret(String appId, OAuth2ClientSecretRequestBody oauth2ClientSecretRequestBody) throws ApiException
      Create an OAuth 2.0 Client Secret Creates an OAuth 2.0 Client Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects. > **Note:** This API lets you bring your own secret. If [token_endpoint_auth_method](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=4/credentials/oauthClient/token_endpoint_auth_method&t=request) of the app is `client_secret_jwt`, then the minimum length of `client_secret` is 32 characters. If no secret is specified in the request, Okta adds a new system-generated secret.
      Parameters:
      appId - Application ID (required)
      oauth2ClientSecretRequestBody - (optional)
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • createOAuth2ClientSecret

      public OAuth2ClientSecret createOAuth2ClientSecret(String appId, OAuth2ClientSecretRequestBody oauth2ClientSecretRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Create an OAuth 2.0 Client Secret Creates an OAuth 2.0 Client Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects. > **Note:** This API lets you bring your own secret. If [token_endpoint_auth_method](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=4/credentials/oauthClient/token_endpoint_auth_method&t=request) of the app is `client_secret_jwt`, then the minimum length of `client_secret` is 32 characters. If no secret is specified in the request, Okta adds a new system-generated secret.
      Parameters:
      appId - Application ID (required)
      oauth2ClientSecretRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • deactivateOAuth2ClientJsonWebKey

      public OAuth2ClientJsonWebKey deactivateOAuth2ClientJsonWebKey(String appId, String keyId) throws ApiException
      Deactivate an OAuth 2.0 Client JSON Web Key Deactivates an OAuth 2.0 Client JSON Web Key by `keyId`.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • deactivateOAuth2ClientJsonWebKey

      public OAuth2ClientJsonWebKey deactivateOAuth2ClientJsonWebKey(String appId, String keyId, Map<String,String> additionalHeaders) throws ApiException
      Deactivate an OAuth 2.0 Client JSON Web Key Deactivates an OAuth 2.0 Client JSON Web Key by `keyId`.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • deactivateOAuth2ClientSecret

      public OAuth2ClientSecret deactivateOAuth2ClientSecret(String appId, String secretId) throws ApiException
      Deactivate an OAuth 2.0 Client Secret Deactivates an OAuth 2.0 Client Secret by `secretId`. You can't deactivate a secret if it's the only secret of the client.
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • deactivateOAuth2ClientSecret

      public OAuth2ClientSecret deactivateOAuth2ClientSecret(String appId, String secretId, Map<String,String> additionalHeaders) throws ApiException
      Deactivate an OAuth 2.0 Client Secret Deactivates an OAuth 2.0 Client Secret by `secretId`. You can't deactivate a secret if it's the only secret of the client.
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • deleteOAuth2ClientSecret

      public void deleteOAuth2ClientSecret(String appId, String secretId) throws ApiException
      Delete an OAuth 2.0 Client Secret Deletes an OAuth 2.0 Client Secret by `secretId`. You can only delete an inactive Secret.
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      Throws:
      ApiException - if fails to make API call

    • deleteOAuth2ClientSecret

      public void deleteOAuth2ClientSecret(String appId, String secretId, Map<String,String> additionalHeaders) throws ApiException
      Delete an OAuth 2.0 Client Secret Deletes an OAuth 2.0 Client Secret by `secretId`. You can only delete an inactive Secret.
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deletejwk

      public void deletejwk(String appId, String keyId) throws ApiException
      Delete an OAuth 2.0 Client JSON Web Key Deletes an OAuth 2.0 Client JSON Web Key by `keyId`. You can only delete an inactive key.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Throws:
      ApiException - if fails to make API call

    • deletejwk

      public void deletejwk(String appId, String keyId, Map<String,String> additionalHeaders) throws ApiException
      Delete an OAuth 2.0 Client JSON Web Key Deletes an OAuth 2.0 Client JSON Web Key by `keyId`. You can only delete an inactive key.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getJwk

      public OAuth2ClientJsonWebKey getJwk(String appId, String keyId) throws ApiException
      Retrieve an OAuth 2.0 Client JSON Web Key Retrieves an OAuth 2.0 Client JSON Web Key by `keyId`.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getJwk

      public OAuth2ClientJsonWebKey getJwk(String appId, String keyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an OAuth 2.0 Client JSON Web Key Retrieves an OAuth 2.0 Client JSON Web Key by `keyId`.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientJsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getOAuth2ClientSecret

      public OAuth2ClientSecret getOAuth2ClientSecret(String appId, String secretId) throws ApiException
      Retrieve an OAuth 2.0 Client Secret Retrieves an OAuth 2.0 Client Secret by `secretId`
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • getOAuth2ClientSecret

      public OAuth2ClientSecret getOAuth2ClientSecret(String appId, String secretId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an OAuth 2.0 Client Secret Retrieves an OAuth 2.0 Client Secret by `secretId`
      Parameters:
      appId - Application ID (required)
      secretId - Unique `id` of the OAuth 2.0 Client Secret (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientSecret
      Throws:
      ApiException - if fails to make API call

    • listJwk

      public List<OAuth2ClientJsonWebKey> listJwk(String appId) throws ApiException
      List all the OAuth 2.0 Client JSON Web Keys Lists all JSON Web Keys for an OAuth 2.0 client app
      Parameters:
      appId - Application ID (required)
      Returns:
      List<OAuth2ClientJsonWebKey>
      Throws:
      ApiException - if fails to make API call

    • listJwk

      public List<OAuth2ClientJsonWebKey> listJwk(String appId, Map<String,String> additionalHeaders) throws ApiException
      List all the OAuth 2.0 Client JSON Web Keys Lists all JSON Web Keys for an OAuth 2.0 client app
      Parameters:
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OAuth2ClientJsonWebKey>
      Throws:
      ApiException - if fails to make API call

    • listOAuth2ClientSecrets

      public List<OAuth2ClientSecret> listOAuth2ClientSecrets(String appId) throws ApiException
      List all OAuth 2.0 Client Secrets Lists all client secrets for an OAuth 2.0 client app
      Parameters:
      appId - Application ID (required)
      Returns:
      List<OAuth2ClientSecret>
      Throws:
      ApiException - if fails to make API call

    • listOAuth2ClientSecrets

      public List<OAuth2ClientSecret> listOAuth2ClientSecrets(String appId, Map<String,String> additionalHeaders) throws ApiException
      List all OAuth 2.0 Client Secrets Lists all client secrets for an OAuth 2.0 client app
      Parameters:
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OAuth2ClientSecret>
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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