linked_object_definitions

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

Overview

Name	linked_object_definitions
Type	Resource
Id	okta.meta.linked_object_definitions

Fields

The following fields are returned by SELECT queries:

list_linked_object_definitions

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
associated	object	(title: LinkedObjectDetails)
primary	object	(title: LinkedObjectDetails)

get_linked_object_definition

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
associated	object	(title: LinkedObjectDetails)
primary	object	(title: LinkedObjectDetails)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_linked_object_definitions	select	subdomain		Lists all Linked Object definitions
get_linked_object_definition	select	subdomain		Retrieves a Linked Object definition
create_linked_object_definition	insert	subdomain		Creates a Linked Object definition
delete_linked_object_definition	delete	subdomain		Deletes the Linked Object definition specified by either the primary or associated name. The entire definition is removed, regardless of which name that you specify.

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_linked_object_definitions

Lists all Linked Object definitions

SELECT
_links,
associated,
primary
FROM okta.meta.linked_object_definitions
WHERE subdomain = '{{ subdomain }}' -- required
;

get_linked_object_definition

Retrieves a Linked Object definition

SELECT
_links,
associated,
primary
FROM okta.meta.linked_object_definitions
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_linked_object_definition

Creates a Linked Object definition

INSERT INTO okta.meta.linked_object_definitions (
data__associated,
data__primary,
data___links,
subdomain
)
SELECT 
'{{ associated }}',
'{{ primary }}',
'{{ _links }}',
'{{ subdomain }}'
RETURNING
_links,
associated,
primary
;

Manifest

# Description fields are for documentation purposes
- name: linked_object_definitions
  props:
    - name: subdomain
      value: string
      description: Required parameter for the linked_object_definitions resource.
    - name: associated
      value: object
    - name: primary
      value: object
    - name: _links
      value: object
      description: >
        Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.
        

DELETE examples

delete_linked_object_definition

Deletes the Linked Object definition specified by either the primary or associated name. The entire definition is removed, regardless of which name that you specify.

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