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	string	The well-known URI content in JSON format (opaque JSON object)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_brand_well_known_uri	select	brandId, path, 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	brandId, path, subdomain, 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
brandId	string	The ID of the brand
path	string	The path of the well-known URI
subdomain	string	(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 brandId = '{{ brandId }}' -- required
AND path = '{{ path }}' -- required
AND 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 
representation = '{{ representation }}'
WHERE 
brandId = '{{ brandId }}' --required
AND path = '{{ path }}' --required
AND subdomain = '{{ subdomain }}' --required
AND representation = '{{ representation }}' --required
RETURNING
_links,
representation;