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-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class CustomDomainApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateCustomDomain
(DomainRequest domain) Create a Custom Domain Creates your custom domaincreateCustomDomain
(DomainRequest domain, Map<String, String> additionalHeaders) Create a Custom Domain Creates your custom domainvoid
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`getCustomDomain
(String domainId) Retrieve a Custom Domain Retrieves a custom domain by `domainId`getCustomDomain
(String domainId, Map<String, String> additionalHeaders) Retrieve a Custom Domain Retrieves a custom domain by `domainId`protected static com.fasterxml.jackson.databind.ObjectMapper
List all Custom Domains Lists all verified custom domains for the orglistCustomDomains
(Map<String, String> additionalHeaders) List all Custom Domains Lists all verified custom domains for the orgreplaceCustomDomain
(String domainId, UpdateDomain updateDomain) Replace a Custom Domain's Brand Replaces a custom domain's brandreplaceCustomDomain
(String domainId, UpdateDomain updateDomain, Map<String, String> additionalHeaders) Replace a Custom Domain's Brand Replaces a custom domain's brandvoid
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.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.verifyDomain
(String domainId) Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.verifyDomain
(String domainId, Map<String, String> additionalHeaders) Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.
-
Constructor Details
-
CustomDomainApi
public CustomDomainApi() -
CustomDomainApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
createCustomDomain
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 ApiExceptionCreate 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
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 ApiExceptionDelete 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
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 ApiExceptionRetrieve 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
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 ApiExceptionList 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 ApiExceptionReplace 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
Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain. If the `certificateSourceType` in the domain is `OKTA_MANAGED`, it becomes `MANUAL` and Okta no longer manages and renews certificates for this domain since a user-managed certificate has been provided.- 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 ApiExceptionUpsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain. If the `certificateSourceType` in the domain is `OKTA_MANAGED`, it becomes `MANUAL` and Okta no longer manages and renews certificates for this domain since a user-managed certificate has been provided.- Parameters:
domainId
- `id` of the Domain (required)certificate
- (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
verifyDomain
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 ApiExceptionVerify 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()
-