Package com.okta.sdk.resource.api

Class CustomDomainApi

java.lang.Object

com.okta.sdk.resource.api.CustomDomainApi

@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 CustomDomainApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CustomDomainApi()
CustomDomainApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
DomainResponse	createCustomDomain(DomainRequest domain)	Create a Custom Domain Creates your custom domain
DomainResponse	createCustomDomain(DomainRequest domain, Map<String,String> additionalHeaders)	Create a Custom Domain Creates your custom domain
void	deleteCustomDomain(String domainId)	Delete a Custom Domain Deletes a custom domain by `domainId`
void	deleteCustomDomain(String domainId, Map<String,String> additionalHeaders)	Delete a Custom Domain Deletes a custom domain by `domainId`
ApiClient	getApiClient()
DomainResponse	getCustomDomain(String domainId)	Retrieve a Custom Domain Retrieves a custom domain by `domainId`
DomainResponse	getCustomDomain(String domainId, Map<String,String> additionalHeaders)	Retrieve a Custom Domain Retrieves a custom domain by `domainId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
DomainListResponse	listCustomDomains()	List all Custom Domains Lists all verified custom domains for the org
DomainListResponse	listCustomDomains(Map<String,String> additionalHeaders)	List all Custom Domains Lists all verified custom domains for the org
DomainResponse	replaceCustomDomain(String domainId, UpdateDomain updateDomain)	Replace a Custom Domain's Brand Replaces a custom domain's brand
DomainResponse	replaceCustomDomain(String domainId, UpdateDomain updateDomain, Map<String,String> additionalHeaders)	Replace a Custom Domain's Brand Replaces a custom domain's brand
void	setApiClient(ApiClient apiClient)
void	upsertCertificate(String domainId, DomainCertificate certificate)	Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`.
void	upsertCertificate(String domainId, DomainCertificate certificate, Map<String,String> additionalHeaders)	Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`.
DomainResponse	verifyDomain(String domainId)	Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.
DomainResponse	verifyDomain(String domainId, Map<String,String> additionalHeaders)	Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomDomainApi

public CustomDomainApi()

CustomDomainApi

public CustomDomainApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCustomDomain

public DomainResponse createCustomDomain(DomainRequest domain)
                                  throws ApiException

Create a Custom Domain Creates your custom domain

Parameters:

domain - (required)

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

createCustomDomain

public DomainResponse createCustomDomain(DomainRequest domain,
 Map<String,String> additionalHeaders)
                                  throws ApiException

Create a Custom Domain Creates your custom domain

Parameters:

domain - (required)

additionalHeaders - additionalHeaders for this call

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

deleteCustomDomain

public void deleteCustomDomain(String domainId)
                        throws ApiException

Delete a Custom Domain Deletes a custom domain by `domainId`

Parameters:

domainId - `id` of the Domain (required)

Throws:

ApiException - if fails to make API call

deleteCustomDomain

public void deleteCustomDomain(String domainId,
 Map<String,String> additionalHeaders)
                        throws ApiException

Delete a Custom Domain Deletes a custom domain by `domainId`

Parameters:

domainId - `id` of the Domain (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getCustomDomain

public DomainResponse getCustomDomain(String domainId)
                               throws ApiException

Retrieve a Custom Domain Retrieves a custom domain by `domainId`

Parameters:

domainId - `id` of the Domain (required)

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

getCustomDomain

public DomainResponse getCustomDomain(String domainId,
 Map<String,String> additionalHeaders)
                               throws ApiException

Retrieve a Custom Domain Retrieves a custom domain by `domainId`

Parameters:

domainId - `id` of the Domain (required)

additionalHeaders - additionalHeaders for this call

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

listCustomDomains

public DomainListResponse listCustomDomains()
                                     throws ApiException

List all Custom Domains Lists all verified custom domains for the org

Returns:

DomainListResponse

Throws:

ApiException - if fails to make API call

listCustomDomains

public DomainListResponse listCustomDomains(Map<String,String> additionalHeaders)
                                     throws ApiException

List all Custom Domains Lists all verified custom domains for the org

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

DomainListResponse

Throws:

ApiException - if fails to make API call

replaceCustomDomain

public DomainResponse replaceCustomDomain(String domainId,
 UpdateDomain updateDomain)
                                   throws ApiException

Replace a Custom Domain's Brand Replaces a custom domain's brand

Parameters:

domainId - `id` of the Domain (required)

updateDomain - (required)

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

replaceCustomDomain

public DomainResponse replaceCustomDomain(String domainId,
 UpdateDomain updateDomain,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Replace a Custom Domain's Brand Replaces a custom domain's brand

Parameters:

domainId - `id` of the Domain (required)

updateDomain - (required)

additionalHeaders - additionalHeaders for this call

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

upsertCertificate

public void upsertCertificate(String domainId,
 DomainCertificate certificate)
                       throws ApiException

Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`. Okta no longer manages and renews certificates for this domain after you provide a user-managed certificate. > * Okta supports TLS certificates and private keys that are PEM-encoded and 2048, 3072, or 4096 bits. See the [Custom domain guide](https://developer.okta.com/docs/guides/custom-url-domain/main/) for more details.

Parameters:

domainId - `id` of the Domain (required)

certificate - (required)

Throws:

ApiException - if fails to make API call

upsertCertificate

public void upsertCertificate(String domainId,
 DomainCertificate certificate,
 Map<String,String> additionalHeaders)
                       throws ApiException

Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`. Okta no longer manages and renews certificates for this domain after you provide a user-managed certificate. > * Okta supports TLS certificates and private keys that are PEM-encoded and 2048, 3072, or 4096 bits. See the [Custom domain guide](https://developer.okta.com/docs/guides/custom-url-domain/main/) for more details.

Parameters:

domainId - `id` of the Domain (required)

certificate - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

verifyDomain

public DomainResponse verifyDomain(String domainId)
                            throws ApiException

Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`. Furthermore, if the `certificateSourceType` in the domain is `OKTA_MANAGED`, then an attempt is made to obtain and install a certificate. After a certificate is obtained and installed by Okta, Okta manages the certificate including certificate renewal.

Parameters:

domainId - `id` of the Domain (required)

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

verifyDomain

public DomainResponse verifyDomain(String domainId,
 Map<String,String> additionalHeaders)
                            throws ApiException

Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`. Furthermore, if the `certificateSourceType` in the domain is `OKTA_MANAGED`, then an attempt is made to obtain and install a certificate. After a certificate is obtained and installed by Okta, Okta manages the certificate including certificate renewal.

Parameters:

domainId - `id` of the Domain (required)

additionalHeaders - additionalHeaders for this call

Returns:

DomainResponse

Throws:

ApiException - if fails to make API call

getObjectMapper

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