Package com.okta.sdk.resource.api

Class AuthorizationServerKeysApi

java.lang.Object

com.okta.sdk.resource.api.AuthorizationServerKeysApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class AuthorizationServerKeysApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuthorizationServerKeysApi()
AuthorizationServerKeysApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
AuthorizationServerJsonWebKey	getAuthorizationServerKey(String authServerId, String keyId)	Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`
AuthorizationServerJsonWebKey	getAuthorizationServerKey(String authServerId, String keyId, Map<String,String> additionalHeaders)	Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<AuthorizationServerJsonWebKey>	listAuthorizationServerKeys(String authServerId)	List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization Server
List<AuthorizationServerJsonWebKey>	listAuthorizationServerKeys(String authServerId, Map<String,String> additionalHeaders)	List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization Server
List<AuthorizationServerJsonWebKey>	rotateAuthorizationServerKeys(String authServerId, JwkUse use)	Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server.
List<AuthorizationServerJsonWebKey>	rotateAuthorizationServerKeys(String authServerId, JwkUse use, Map<String,String> additionalHeaders)	Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationServerKeysApi

public AuthorizationServerKeysApi()

AuthorizationServerKeysApi

public AuthorizationServerKeysApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAuthorizationServerKey

public AuthorizationServerJsonWebKey getAuthorizationServerKey(String authServerId,
 String keyId)
                                                        throws ApiException

Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`

Parameters:

authServerId - `id` of the Authorization Server (required)

keyId - `id` of the certificate key (required)

Returns:

AuthorizationServerJsonWebKey

Throws:

ApiException - if fails to make API call

getAuthorizationServerKey

public AuthorizationServerJsonWebKey getAuthorizationServerKey(String authServerId,
 String keyId,
 Map<String,String> additionalHeaders)
                                                        throws ApiException

Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`

Parameters:

authServerId - `id` of the Authorization Server (required)

keyId - `id` of the certificate key (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthorizationServerJsonWebKey

Throws:

ApiException - if fails to make API call

listAuthorizationServerKeys

public List<AuthorizationServerJsonWebKey> listAuthorizationServerKeys(String authServerId)
                                                                throws ApiException

List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization Server

Parameters:

authServerId - `id` of the Authorization Server (required)

Returns:

List<AuthorizationServerJsonWebKey>

Throws:

ApiException - if fails to make API call

listAuthorizationServerKeys

public List<AuthorizationServerJsonWebKey> listAuthorizationServerKeys(String authServerId,
 Map<String,String> additionalHeaders)
                                                                throws ApiException

List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization Server

Parameters:

authServerId - `id` of the Authorization Server (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<AuthorizationServerJsonWebKey>

Throws:

ApiException - if fails to make API call

rotateAuthorizationServerKeys

public List<AuthorizationServerJsonWebKey> rotateAuthorizationServerKeys(String authServerId,
 JwkUse use)
                                                                  throws ApiException

Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server. If you rotate Keys, the `ACTIVE` Key becomes the `EXPIRED` Key, the `NEXT` Key becomes the `ACTIVE` Key, and the Custom Authorization Server immediately begins using the new active Key to sign tokens. > **Note:** Okta rotates your Keys automatically in `AUTO` mode. You can rotate Keys yourself in either mode. If Keys are rotated manually, you should invalidate any intermediate cache and fetch the Keys again using the Keys endpoint.

Parameters:

authServerId - `id` of the Authorization Server (required)

use - (required)

Returns:

List<AuthorizationServerJsonWebKey>

Throws:

ApiException - if fails to make API call

rotateAuthorizationServerKeys

public List<AuthorizationServerJsonWebKey> rotateAuthorizationServerKeys(String authServerId,
 JwkUse use,
 Map<String,String> additionalHeaders)
                                                                  throws ApiException

Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server. If you rotate Keys, the `ACTIVE` Key becomes the `EXPIRED` Key, the `NEXT` Key becomes the `ACTIVE` Key, and the Custom Authorization Server immediately begins using the new active Key to sign tokens. > **Note:** Okta rotates your Keys automatically in `AUTO` mode. You can rotate Keys yourself in either mode. If Keys are rotated manually, you should invalidate any intermediate cache and fetch the Keys again using the Keys endpoint.

Parameters:

authServerId - `id` of the Authorization Server (required)

use - (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<AuthorizationServerJsonWebKey>

Throws:

ApiException - if fails to make API call

getObjectMapper

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