Package com.okta.sdk.resource.api

Class ApplicationSsoPublicKeysApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationSsoPublicKeysApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class ApplicationSsoPublicKeysApi extends Object

  • Constructor Details

    • ApplicationSsoPublicKeysApi

      public ApplicationSsoPublicKeysApi()

    • ApplicationSsoPublicKeysApi

      public ApplicationSsoPublicKeysApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateOAuth2ClientJsonWebKey

      public ListJwk200ResponseInner 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` > **Note:** You can have only one active encryption key at any given time for app. When you activate an inactive key, the current active key is automatically deactivated.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Returns:
      ListJwk200ResponseInner
      Throws:
      ApiException - if fails to make API call

    • activateOAuth2ClientJsonWebKey

      public ListJwk200ResponseInner 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` > **Note:** You can have only one active encryption key at any given time for app. When you activate an inactive key, the current active key is automatically deactivated.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ListJwk200ResponseInner
      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 ListJwk200ResponseInner addJwk(String appId, AddJwkRequest addJwkRequest) 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/ApplicationSSOPublicKeys/#tag/ApplicationSSOPublicKeys/operation/deletejwk) and re-add the key with a `kid`.
      Parameters:
      appId - Application ID (required)
      addJwkRequest - (required)
      Returns:
      ListJwk200ResponseInner
      Throws:
      ApiException - if fails to make API call

    • addJwk

      public ListJwk200ResponseInner addJwk(String appId, AddJwkRequest addJwkRequest, 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/ApplicationSSOPublicKeys/#tag/ApplicationSSOPublicKeys/operation/deletejwk) and re-add the key with a `kid`.
      Parameters:
      appId - Application ID (required)
      addJwkRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ListJwk200ResponseInner
      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 OAuth2ClientJsonSigningKeyResponse 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`. > **Note:** You can only deactivate signing keys. Deactivating the active encryption key isn't allowed if the client has ID token encryption enabled. You can activate another encryption key, which makes the current key inactive.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      Returns:
      OAuth2ClientJsonSigningKeyResponse
      Throws:
      ApiException - if fails to make API call

    • deactivateOAuth2ClientJsonWebKey

      public OAuth2ClientJsonSigningKeyResponse 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`. > **Note:** You can only deactivate signing keys. Deactivating the active encryption key isn't allowed if the client has ID token encryption enabled. You can activate another encryption key, which makes the current key inactive.
      Parameters:
      appId - Application ID (required)
      keyId - Unique `id` of the OAuth 2.0 Client JSON Web Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2ClientJsonSigningKeyResponse
      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 GetJwk200Response 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:
      GetJwk200Response
      Throws:
      ApiException - if fails to make API call

    • getJwk

      public GetJwk200Response 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:
      GetJwk200Response
      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<ListJwk200ResponseInner> 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<ListJwk200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • listJwk

      public List<ListJwk200ResponseInner> 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<ListJwk200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • listJwkPaged

      public Iterable<ListJwk200ResponseInner> listJwkPaged(String appId)
      List all the OAuth 2.0 client JSON Web Keys (Paginated) Lists all JSON Web Keys for an OAuth 2.0 client app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      appId - Application ID (required)
      Returns:
      Iterable<ListJwk200ResponseInner> lazy iterable over all pages

    • listJwkPaged

      public Iterable<ListJwk200ResponseInner> listJwkPaged(String appId, Map<String,String> additionalHeaders)
      List all the OAuth 2.0 client JSON Web Keys (Paginated with additional headers) Lists all JSON Web Keys for an OAuth 2.0 client app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      appId - Application ID (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<ListJwk200ResponseInner> lazy iterable over all pages

    • 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

    • listOAuth2ClientSecretsPaged

      public Iterable<OAuth2ClientSecret> listOAuth2ClientSecretsPaged(String appId)
      List all OAuth 2.0 client secrets (Paginated) Lists all client secrets for an OAuth 2.0 client app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      appId - Application ID (required)
      Returns:
      Iterable<OAuth2ClientSecret> lazy iterable over all pages

    • listOAuth2ClientSecretsPaged

      public Iterable<OAuth2ClientSecret> listOAuth2ClientSecretsPaged(String appId, Map<String,String> additionalHeaders)
      List all OAuth 2.0 client secrets (Paginated with additional headers) Lists all client secrets for an OAuth 2.0 client app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      appId - Application ID (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<OAuth2ClientSecret> lazy iterable over all pages

    • getObjectMapper

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