Package com.okta.sdk.resource.api

Class IdentityProviderSigningKeysApi

java.lang.Object

com.okta.sdk.resource.api.IdentityProviderSigningKeysApi

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

Constructor Summary

Constructors

Constructor	Description
IdentityProviderSigningKeysApi()
IdentityProviderSigningKeysApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IdPKeyCredential	cloneIdentityProviderKey(String idpId, String kid, String targetIdpId)	Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice.
IdPKeyCredential	cloneIdentityProviderKey(String idpId, String kid, String targetIdpId, Map<String,String> additionalHeaders)	Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice.
IdPCsr	generateCsrForIdentityProvider(String idpId, CsrMetadata metadata)	Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request (CSR) for it > **Note:** The private key isn't listed in the [Signing Key Credentials for IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.
IdPCsr	generateCsrForIdentityProvider(String idpId, CsrMetadata metadata, Map<String,String> additionalHeaders)	Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request (CSR) for it > **Note:** The private key isn't listed in the [Signing Key Credentials for IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.
IdPKeyCredential	generateIdentityProviderSigningKey(String idpId, Integer validityYears)	Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP.
IdPKeyCredential	generateIdentityProviderSigningKey(String idpId, Integer validityYears, Map<String,String> additionalHeaders)	Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP.
ApiClient	getApiClient()
IdPCsr	getCsrForIdentityProvider(String idpId, String idpCsrId)	Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`
IdPCsr	getCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders)	Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`
IdPKeyCredential	getIdentityProviderSigningKey(String idpId, String kid)	Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`
IdPKeyCredential	getIdentityProviderSigningKey(String idpId, String kid, Map<String,String> additionalHeaders)	Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<IdPCsr>	listCsrsForIdentityProvider(String idpId)	List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
List<IdPCsr>	listCsrsForIdentityProvider(String idpId, Map<String,String> additionalHeaders)	List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
List<IdPKeyCredential>	listIdentityProviderSigningKeys(String idpId)	List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdP
List<IdPKeyCredential>	listIdentityProviderSigningKeys(String idpId, Map<String,String> additionalHeaders)	List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdP
IdPKeyCredential	publishCsrForIdentityProvider(String idpId, String idpCsrId, File body)	Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.
IdPKeyCredential	publishCsrForIdentityProvider(String idpId, String idpCsrId, File body, Map<String,String> additionalHeaders)	Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.
void	revokeCsrForIdentityProvider(String idpId, String idpCsrId)	Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdP
void	revokeCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders)	Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdP
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

IdentityProviderSigningKeysApi

public IdentityProviderSigningKeysApi()

IdentityProviderSigningKeysApi

public IdentityProviderSigningKeysApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cloneIdentityProviderKey

public IdPKeyCredential cloneIdentityProviderKey(String idpId,
 String kid,
 String targetIdpId)
                                          throws ApiException

Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice. > **Note:** If the key is already present in the list of Key Credentials for the target IdP, you receive a 400 error response.

Parameters:

idpId - `id` of IdP (required)

kid - Unique `id` of the IdP Key Credential (required)

targetIdpId - `id` of the target IdP (required)

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

cloneIdentityProviderKey

public IdPKeyCredential cloneIdentityProviderKey(String idpId,
 String kid,
 String targetIdpId,
 Map<String,String> additionalHeaders)
                                          throws ApiException

Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice. > **Note:** If the key is already present in the list of Key Credentials for the target IdP, you receive a 400 error response.

Parameters:

idpId - `id` of IdP (required)

kid - Unique `id` of the IdP Key Credential (required)

targetIdpId - `id` of the target IdP (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

generateCsrForIdentityProvider

public IdPCsr generateCsrForIdentityProvider(String idpId,
 CsrMetadata metadata)
                                      throws ApiException

Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request (CSR) for it > **Note:** The private key isn't listed in the [Signing Key Credentials for IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.

Parameters:

idpId - `id` of IdP (required)

metadata - (required)

Returns:

IdPCsr

Throws:

ApiException - if fails to make API call

generateCsrForIdentityProvider

public IdPCsr generateCsrForIdentityProvider(String idpId,
 CsrMetadata metadata,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request (CSR) for it > **Note:** The private key isn't listed in the [Signing Key Credentials for IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.

Parameters:

idpId - `id` of IdP (required)

metadata - (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPCsr

Throws:

ApiException - if fails to make API call

generateIdentityProviderSigningKey

public IdPKeyCredential generateIdentityProviderSigningKey(String idpId,
 Integer validityYears)
                                                    throws ApiException

Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP. IdP signing keys are read-only. > **Note:** To update an IdP with the newly generated Key Credential, [update your IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider) using the returned key's `kid` in the [signing credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/credentials/signing/kid&t=request).

Parameters:

idpId - `id` of IdP (required)

validityYears - expiry of the IdP Key Credential (required)

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

generateIdentityProviderSigningKey

public IdPKeyCredential generateIdentityProviderSigningKey(String idpId,
 Integer validityYears,
 Map<String,String> additionalHeaders)
                                                    throws ApiException

Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP. IdP signing keys are read-only. > **Note:** To update an IdP with the newly generated Key Credential, [update your IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider) using the returned key's `kid` in the [signing credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/credentials/signing/kid&t=request).

Parameters:

idpId - `id` of IdP (required)

validityYears - expiry of the IdP Key Credential (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

getCsrForIdentityProvider

public IdPCsr getCsrForIdentityProvider(String idpId,
 String idpCsrId)
                                 throws ApiException

Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

Returns:

IdPCsr

Throws:

ApiException - if fails to make API call

getCsrForIdentityProvider

public IdPCsr getCsrForIdentityProvider(String idpId,
 String idpCsrId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPCsr

Throws:

ApiException - if fails to make API call

getIdentityProviderSigningKey

public IdPKeyCredential getIdentityProviderSigningKey(String idpId,
 String kid)
                                               throws ApiException

Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`

Parameters:

idpId - `id` of IdP (required)

kid - Unique `id` of the IdP Key Credential (required)

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

getIdentityProviderSigningKey

public IdPKeyCredential getIdentityProviderSigningKey(String idpId,
 String kid,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`

Parameters:

idpId - `id` of IdP (required)

kid - Unique `id` of the IdP Key Credential (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

listCsrsForIdentityProvider

public List<IdPCsr> listCsrsForIdentityProvider(String idpId)
                                         throws ApiException

List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP

Parameters:

idpId - `id` of IdP (required)

Returns:

List<IdPCsr>

Throws:

ApiException - if fails to make API call

listCsrsForIdentityProvider

public List<IdPCsr> listCsrsForIdentityProvider(String idpId,
 Map<String,String> additionalHeaders)
                                         throws ApiException

List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP

Parameters:

idpId - `id` of IdP (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<IdPCsr>

Throws:

ApiException - if fails to make API call

listIdentityProviderSigningKeys

public List<IdPKeyCredential> listIdentityProviderSigningKeys(String idpId)
                                                       throws ApiException

List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdP

Parameters:

idpId - `id` of IdP (required)

Returns:

List<IdPKeyCredential>

Throws:

ApiException - if fails to make API call

listIdentityProviderSigningKeys

public List<IdPKeyCredential> listIdentityProviderSigningKeys(String idpId,
 Map<String,String> additionalHeaders)
                                                       throws ApiException

List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdP

Parameters:

idpId - `id` of IdP (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<IdPKeyCredential>

Throws:

ApiException - if fails to make API call

publishCsrForIdentityProvider

public IdPKeyCredential publishCsrForIdentityProvider(String idpId,
 String idpCsrId,
 File body)
                                               throws ApiException

Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible. > * If the validity period of the certificate is less than 90 days, a 400 error response is returned.

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

body - (required)

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

publishCsrForIdentityProvider

public IdPKeyCredential publishCsrForIdentityProvider(String idpId,
 String idpCsrId,
 File body,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible. > * If the validity period of the certificate is less than 90 days, a 400 error response is returned.

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

body - (required)

additionalHeaders - additionalHeaders for this call

Returns:

IdPKeyCredential

Throws:

ApiException - if fails to make API call

revokeCsrForIdentityProvider

public void revokeCsrForIdentityProvider(String idpId,
 String idpCsrId)
                                  throws ApiException

Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdP

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

Throws:

ApiException - if fails to make API call

revokeCsrForIdentityProvider

public void revokeCsrForIdentityProvider(String idpId,
 String idpCsrId,
 Map<String,String> additionalHeaders)
                                  throws ApiException

Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdP

Parameters:

idpId - `id` of IdP (required)

idpCsrId - `id` of the IdP CSR (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

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