ui_schemas

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

Overview

Name	ui_schemas
Type	Resource
Id	okta.meta.ui_schemas

Fields

The following fields are returned by SELECT queries:

list_uischemas

Name	Datatype	Description
id	string	Unique identifier for the UI Schema
_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.
created	string (date-time)	Timestamp when the UI Schema was created (ISO 86001)
lastUpdated	string (date-time)	Timestamp when the UI Schema was last modified (ISO 86001)
uiSchema	object	Properties of the UI schema

get_uischema

Name	Datatype	Description
id	string	Unique identifier for the UI Schema
_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.
created	string (date-time)	Timestamp when the UI Schema was created (ISO 86001)
lastUpdated	string (date-time)	Timestamp when the UI Schema was last modified (ISO 86001)
uiSchema	object	Properties of the UI schema

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_uischemas	select	subdomain		Lists all UI Schemas in your org
get_uischema	select	subdomain		Retrieves a UI Schema by id
create_uischema	insert	subdomain		Creates an input for an enrollment form
replace_uischemas	replace	subdomain		Replaces a UI Schema by id
delete_uischemas	delete	subdomain		Deletes a UI Schema by id

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_uischemas

Lists all UI Schemas in your org

SELECT
id,
_links,
created,
lastUpdated,
uiSchema
FROM okta.meta.ui_schemas
WHERE subdomain = '{{ subdomain }}' -- required
;

get_uischema

Retrieves a UI Schema by id

SELECT
id,
_links,
created,
lastUpdated,
uiSchema
FROM okta.meta.ui_schemas
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_uischema

Creates an input for an enrollment form

INSERT INTO okta.meta.ui_schemas (
data__uiSchema,
subdomain
)
SELECT 
'{{ uiSchema }}',
'{{ subdomain }}'
RETURNING
id,
_links,
created,
lastUpdated,
uiSchema
;

Manifest

# Description fields are for documentation purposes
- name: ui_schemas
  props:
    - name: subdomain
      value: string
      description: Required parameter for the ui_schemas resource.
    - name: uiSchema
      value: object
      description: >
        Properties of the UI schema
        

REPLACE examples

replace_uischemas

Replaces a UI Schema by id

REPLACE okta.meta.ui_schemas
SET 
data__uiSchema = '{{ uiSchema }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
created,
lastUpdated,
uiSchema
;

DELETE examples

delete_uischemas

Deletes a UI Schema by id

DELETE FROM okta.meta.ui_schemas
WHERE subdomain = '{{ subdomain }}' --required
;