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 | contactType, subdomain | Retrieves the ID and the user resource associated with the specified contact type | |
replace_org_contact_user | replace | contactType, 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 |
|---|---|---|
contactType | string | |
subdomain | string | (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 contactType = '{{ contactType }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;
REPLACE examples​
- replace_org_contact_user
Replaces the user associated with the specified contact type
REPLACE okta.org.contacts
SET
userId = '{{ userId }}'
WHERE
contactType = '{{ contactType }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
_links,
userId;