POST /api/v1/meta/schemas/user/linkedObjects

Creates a Linked Object definition

Servers

https://{yourOktaDomain}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`_links`	Object	No	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.
`_links.self`	Object	No
`_links.self.href`	String	Yes	Link URI
`associated`	Object	No
`associated.name`	String	Yes	API name of the `primary` or the `associated` link. The `name` parameter can't start with a number and can only contain the following characters: `a-z`, `A-Z`,`0-9`, and `_`.
`associated.description`	String	No	Description of the `primary` or the `associated` relationship
`associated.title`	String	Yes	Display name of the `primary` or the `associated` link
`associated.type`	String	Yes	The object type for this relationship Possible values: `"USER"`
`primary`	Object	No
`primary.name`	String	Yes	API name of the `primary` or the `associated` link. The `name` parameter can't start with a number and can only contain the following characters: `a-z`, `A-Z`,`0-9`, and `_`.
`primary.description`	String	No	Description of the `primary` or the `associated` relationship
`primary.title`	String	Yes	Display name of the `primary` or the `associated` link
`primary.type`	String	Yes	The object type for this relationship Possible values: `"USER"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.