On this page

Linked Objects API

The Okta Linked Objects API provides operations to manage Okta relationships between Users.

Explore the Okta Public API Collections (opens new window) workspace to get started with the Linked Objects API.

Link definition operations allow you to manage the creation and removal of the link definitions. If you remove a link definition, links based on that definition are unavailable. These operations are available at the new Okta API reference portal (opens new window) as part of the Linked Objects API (opens new window).

Add Linked Object definition to User Profile schema

See Create a Linked Object Definition (opens new window) in the new Okta API reference portal (opens new window).

Get a Linked Object definition by name

See Retrieve a Linked Object Definition (opens new window) in the new Okta API reference portal (opens new window).

Get all Linked Object definitions

See List all Linked Object Definitions (opens new window) in the new Okta API reference portal (opens new window).

Remove Linked Object definition

See Delete a Linked Object Definition (opens new window) in the new Okta API reference portal (opens new window).

Use link value operations to assign users to a relationship (a pair of primary and associated links). These operations are available at the new Okta API reference portal (opens new window) as part of the User Linked Objects API (opens new window).

Set Linked Object value for primary

See Assign a Linked Object value for primary (opens new window) in the new Okta API reference portal (opens new window).

Get primary Linked Object value

See List the primary or all of the associated Linked Object values (opens new window) in the new Okta API reference portal (opens new window).

Get associated Linked Object values

See List the primary or all of the associated Linked Object values (opens new window) in the new Okta API reference portal (opens new window).

Delete Linked Object value

See Delete a Linked Object value (opens new window) in the new Okta API reference portal (opens new window).

Linked Object object

See Linked Object - response payload (opens new window) in the new Okta API reference portal (opens new window).