support_aerial_consent

Creates, updates, deletes, gets or lists a support_aerial_consent resource.

Overview

Name	support_aerial_consent
Type	Resource
Id	okta.org.support_aerial_consent

Fields

The following fields are returned by SELECT queries:

get_aerial_consent

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
accountId	string	The unique ID of the Aerial account
grantedBy	string	Principal ID of the user who granted the permission (example: 00u23ej02I2RLFxS5406)
grantedDate	string	Date when grant was created (example: 2024-07-24T16:01:13.000Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_aerial_consent	select	subdomain		Retrieves the Okta Aerial consent grant details for your Org. Returns a 404 Not Found error if no consent has been granted.
grant_aerial_consent	insert	subdomain, data__accountId		Grants an Okta Aerial account consent to manage your org. If the org is a child org, consent is taken from the parent org. Grant calls directly to the child are not allowed.
revoke_aerial_consent	delete	subdomain		Revokes access of an Okta Aerial account to your Org. The revoke operation will fail if the org has already been added to an Aerial account.

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_aerial_consent

Retrieves the Okta Aerial consent grant details for your Org. Returns a 404 Not Found error if no consent has been granted.

SELECT
_links,
accountId,
grantedBy,
grantedDate
FROM okta.org.support_aerial_consent
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

grant_aerial_consent

Grants an Okta Aerial account consent to manage your org. If the org is a child org, consent is taken from the parent org. Grant calls directly to the child are not allowed.

INSERT INTO okta.org.support_aerial_consent (
data__accountId,
subdomain
)
SELECT 
'{{ accountId }}' /* required */,
'{{ subdomain }}'
RETURNING
_links,
accountId,
grantedBy,
grantedDate
;

Manifest

# Description fields are for documentation purposes
- name: support_aerial_consent
  props:
    - name: subdomain
      value: string
      description: Required parameter for the support_aerial_consent resource.
    - name: accountId
      value: string
      description: >
        The unique ID of the Aerial account
        

DELETE examples

revoke_aerial_consent

Revokes access of an Okta Aerial account to your Org. The revoke operation will fail if the org has already been added to an Aerial account.

DELETE FROM okta.org.support_aerial_consent
WHERE subdomain = '{{ subdomain }}' --required
;