well_known_uris

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

Overview

Name	well_known_uris
Type	Resource
Id	okta.brands.well_known_uris

Fields

The following fields are returned by SELECT queries:

get_root_brand_well_known_uri

Successfully retrieved the well-known URI

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)

get_all_well_known_uris

Successfully retrieved all the well-known URIs

Name	Datatype	Description
_embedded	object
_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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_root_brand_well_known_uri	select	brandId, path, subdomain	expand	Retrieves the well-known URI of a specific brand and well-known URI path
get_all_well_known_uris	select	brandId, subdomain	expand	Retrieves the content from each of the well-known URIs for a specified brand

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)
expand	array	Specifies additional metadata to include in the response

SELECT examples

get_root_brand_well_known_uri

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

SELECT
_links,
representation
FROM okta.brands.well_known_uris
WHERE brandId = '{{ brandId }}' -- required
AND path = '{{ path }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;

get_all_well_known_uris

Retrieves the content from each of the well-known URIs for a specified brand

SELECT
_embedded,
_links
FROM okta.brands.well_known_uris
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;