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_all_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 (example: ACTIVE)

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 (example: ACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_all_cross_app_access_connections	select	subdomain	after, limit	Retrieves inbound and outbound Cross App Access connections associated with an app
get_cross_app_access_connection	select	subdomain		Retrieves the Cross App Access connection with the specified ID
create_cross_app_access_connection	insert	subdomain		Creates a Cross App Access connection
update_cross_app_access_connection	update	subdomain, data__status		Updates the Cross App Access connection with the specified ID
delete_cross_app_access_connection	delete	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
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)
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)

SELECT examples

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 subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}';

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 subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_cross_app_access_connection

Creates a Cross App Access connection

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

Manifest

# Description fields are for documentation purposes
- name: cross_app_access_connections
  props:
    - name: subdomain
      value: string
      description: Required parameter for the cross_app_access_connections resource.
    - name: requestingAppInstanceId
      value: string
      description: >
        ID of the requesting app instance
        
    - name: resourceAppInstanceId
      value: string
      description: >
        ID of the resource app instance
        
    - name: status
      value: string
      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 
data__status = '{{ status }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__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 subdomain = '{{ subdomain }}' --required;