cross_app_access_connections

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

Overview

Name	cross_app_access_connections
Type	Resource
Id	okta.apps.cross_app_access_connections

Fields

The following fields are returned by SELECT queries:

get_cross_app_access_connection

Name	Datatype	Description
id	string	Unique identifier for the connection (example: cwofxqCAJWWGELFTYASJ)
created	string (date-time)	The ISO 8601 formatted date and time when the connection was created (example: 2024-10-15T10:30:00.000Z)
lastUpdated	string (date-time)	The ISO 8601 formatted date and time when the connection was last updated (example: 2024-10-15T14:20:00.000Z)
requestingAppInstanceId	string	ID of the requesting app instance (example: 0oafxqCAJWWGELFTYASJ)
resourceAppInstanceId	string	ID of the resource app instance (example: 0oafxqCBJWWGELFTYASK)
status	string	Indicates if the Cross App Access connection is active or inactive (ACTIVE, INACTIVE) (example: ACTIVE)

get_all_cross_app_access_connections

Connection object for Cross App Access connections

Name	Datatype	Description
id	string	Unique identifier for the connection (example: cwofxqCAJWWGELFTYASJ)
created	string (date-time)	The ISO 8601 formatted date and time when the connection was created (example: 2024-10-15T10:30:00.000Z)
lastUpdated	string (date-time)	The ISO 8601 formatted date and time when the connection was last updated (example: 2024-10-15T14:20:00.000Z)
requestingAppInstanceId	string	ID of the requesting app instance (example: 0oafxqCAJWWGELFTYASJ)
resourceAppInstanceId	string	ID of the resource app instance (example: 0oafxqCBJWWGELFTYASK)
status	string	Indicates if the Cross App Access connection is active or inactive (ACTIVE, INACTIVE) (example: ACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cross_app_access_connection	select	appId, connectionId, subdomain		Retrieves the Cross App Access connection with the specified ID
get_all_cross_app_access_connections	select	appId, subdomain	after, limit, status, requestingAppId, resourceAppId, activeAppsOnly, requestingAppName, resourceAppName	Retrieves inbound and outbound Cross App Access connections associated with an app
create_cross_app_access_connection	insert	appId, subdomain		Creates a Cross App Access connection
update_cross_app_access_connection	update	appId, connectionId, subdomain, status		Updates the Cross App Access connection with the specified ID
delete_cross_app_access_connection	delete	appId, connectionId, subdomain		Deletes a Cross App Access connection with the specified ID

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
appId	string	Application ID
connectionId	string	Connection ID
subdomain	string	(default: my-org)
activeAppsOnly	string	When set to true, filters the result to include only connections where both the requesting and resource app have a status of ACTIVE (example: true)
after	string	Specifies the pagination cursor for the next page of connection results
limit	integer (int32)	Specifies the number of results to return per page. The values: * -1: Return all results (up to system maximum) * 0: Return an empty result set * Positive integer: Return up to that many results (capped at system maximum)
requestingAppId	string	Filters only connections where the app with the specified ID is the requesting app (example: 0oa8mm6ktyXqkcs5t0g7)
requestingAppName	string	Filters connections where the requesting app's name matches the provided search string (example: zoom)
resourceAppId	string	Filters only connections where the app with the specified ID is the requesting app (example: 0oa8mmm7ruidxWhlf0g7)
resourceAppName	string	Filters connections where the resource app's name matches the provided search string (example: box)
status	string	Filters connections by their lifecycle status. When specified, only connections that match the specified status are returned. (example: ACTIVE)

SELECT examples

get_cross_app_access_connection

Retrieves the Cross App Access connection with the specified ID

SELECT
id,
created,
lastUpdated,
requestingAppInstanceId,
resourceAppInstanceId,
status
FROM okta.apps.cross_app_access_connections
WHERE appId = '{{ appId }}' -- required
AND connectionId = '{{ connectionId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

get_all_cross_app_access_connections

Retrieves inbound and outbound Cross App Access connections associated with an app

SELECT
id,
created,
lastUpdated,
requestingAppInstanceId,
resourceAppInstanceId,
status
FROM okta.apps.cross_app_access_connections
WHERE appId = '{{ appId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND status = '{{ status }}'
AND requestingAppId = '{{ requestingAppId }}'
AND resourceAppId = '{{ resourceAppId }}'
AND activeAppsOnly = '{{ activeAppsOnly }}'
AND requestingAppName = '{{ requestingAppName }}'
AND resourceAppName = '{{ resourceAppName }}'
;

INSERT examples

create_cross_app_access_connection

Creates a Cross App Access connection

INSERT INTO okta.apps.cross_app_access_connections (
requestingAppInstanceId,
resourceAppInstanceId,
status,
appId,
subdomain
)
SELECT 
'{{ requestingAppInstanceId }}',
'{{ resourceAppInstanceId }}',
'{{ status }}',
'{{ appId }}',
'{{ subdomain }}'
RETURNING
id,
created,
lastUpdated,
requestingAppInstanceId,
resourceAppInstanceId,
status
;

Manifest

# Description fields are for documentation purposes
- name: cross_app_access_connections
props:
  - name: appId
    value: "{{ appId }}"
    description: Required parameter for the cross_app_access_connections resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the cross_app_access_connections resource.
  - name: requestingAppInstanceId
    value: "{{ requestingAppInstanceId }}"
    description: |
      ID of the requesting app instance
  - name: resourceAppInstanceId
    value: "{{ resourceAppInstanceId }}"
    description: |
      ID of the resource app instance
  - name: status
    value: "{{ status }}"
    description: |
      Indicates if the Cross App Access connection is active or inactive
    valid_values: ['ACTIVE', 'INACTIVE']

UPDATE examples

update_cross_app_access_connection

Updates the Cross App Access connection with the specified ID

UPDATE okta.apps.cross_app_access_connections
SET 
status = '{{ status }}'
WHERE 
appId = '{{ appId }}' --required
AND connectionId = '{{ connectionId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND status = '{{ status }}' --required
RETURNING
id,
created,
lastUpdated,
requestingAppInstanceId,
resourceAppInstanceId,
status;

DELETE examples

delete_cross_app_access_connection

Deletes a Cross App Access connection with the specified ID

DELETE FROM okta.apps.cross_app_access_connections
WHERE appId = '{{ appId }}' --required
AND connectionId = '{{ connectionId }}' --required
AND subdomain = '{{ subdomain }}' --required
;