contacts
Creates, updates, deletes, gets or lists a contacts resource.
Overview
| Name | contacts |
| Type | Resource |
| Id | okta.org.contacts |
Fields
The following fields are returned by SELECT queries:
- get_org_contact_user
| Name | Datatype | Description |
|---|---|---|
_links | object | Specifies link relations (see Web Linking) available for the contact type user object using the JSON Hypertext Application Language specification |
userId | string | Contact user ID |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_org_contact_user | select | subdomain | Retrieves the ID and the user resource associated with the specified contact type | |
replace_org_contact_user | replace | subdomain | Replaces the user associated with the specified contact type |
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
- get_org_contact_user
Retrieves the ID and the user resource associated with the specified contact type
SELECT
_links,
userId
FROM okta.org.contacts
WHERE subdomain = '{{ subdomain }}' -- required
;
REPLACE examples
- replace_org_contact_user
Replaces the user associated with the specified contact type
REPLACE okta.org.contacts
SET
data__userId = '{{ userId }}'
WHERE
subdomain = '{{ subdomain }}' --required
RETURNING
_links,
userId
;