domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	okta.brands.domains

Fields

The following fields are returned by SELECT queries:

list_brand_domains

Successfully returned the list of domains for the brand

Name	Datatype	Description
id	string	Unique ID of the domain (example: OcDz6iRyjkaCTXkdo0g3)
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
brandId	string	The ID number of the brand (example: bndul904tTZ6kWVhP0g3)
certificateSourceType	string	Certificate source type that indicates whether the certificate is provided by the user or Okta.
dnsRecords	array
domain	string	Custom domain name (example: login.example.com)
publicCertificate	object	Certificate metadata for the domain
validationStatus	string	Status of the domain (example: VERIFIED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_brand_domains	select	subdomain		Lists all domains associated with a brand by brandId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_brand_domains

Lists all domains associated with a brand by brandId

SELECT
id,
_links,
brandId,
certificateSourceType,
dnsRecords,
domain,
publicCertificate,
validationStatus
FROM okta.brands.domains
WHERE subdomain = '{{ subdomain }}' -- required
;