brand_well_known_uris

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

Overview

Name	brand_well_known_uris
Type	Resource
Id	okta.brands.brand_well_known_uris

Fields

The following fields are returned by SELECT queries:

get_brand_well_known_uri

Successfully retrieved the customized well-known URI content

Name	Datatype	Description
_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.
representation	object	The well-known URI content in JSON format

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_brand_well_known_uri	select	subdomain		Retrieves the customized content of a well-known URI for a specific brand and well-known URI path
replace_brand_well_known_uri	replace	subdomain, data__representation		Replaces the content of a customized well-known URI that you specify. There are endpoint-specific format requirements when you update the content of a customized well-known URI. See Customize associated domains.

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

get_brand_well_known_uri

Retrieves the customized content of a well-known URI for a specific brand and well-known URI path

SELECT
_links,
representation
FROM okta.brands.brand_well_known_uris
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_brand_well_known_uri

Replaces the content of a customized well-known URI that you specify.

There are endpoint-specific format requirements when you update the content of a customized well-known URI. See Customize associated domains.

REPLACE okta.brands.brand_well_known_uris
SET 
data__representation = '{{ representation }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__representation = '{{ representation }}' --required
RETURNING
_links,
representation
;