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:

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)

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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_linked_object_definition	select	linkedObjectName, subdomain		Retrieves a Linked Object definition
list_linked_object_definitions	select	subdomain		Lists all Linked Object definitions
create_linked_object_definition	insert	subdomain		Creates a Linked Object definition
delete_linked_object_definition	delete	linkedObjectName, 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
linkedObjectName	string	Primary or Associated name
subdomain	string	(default: my-org)

SELECT examples

get_linked_object_definition

Retrieves a Linked Object definition

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

list_linked_object_definitions

Lists all Linked Object definitions

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 (
associated,
primary,
_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: "{{ subdomain }}"
    description: Required parameter for the linked_object_definitions resource.
  - name: associated
    value:
      description: "{{ description }}"
      name: "{{ name }}"
      title: "{{ title }}"
      type: "{{ type }}"
  - name: primary
    value:
      description: "{{ description }}"
      name: "{{ name }}"
      title: "{{ title }}"
      type: "{{ type }}"
  - name: _links
    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.
    value:
      self:
        href: "{{ href }}"

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 linkedObjectName = '{{ linkedObjectName }}' --required
AND subdomain = '{{ subdomain }}' --required
;