Application Cross App Access Connections

The Application Cross App Access Connections API provides operations to configure and manage Cross App Access connections between a requesting app and a resource app.

To establish the Cross App Access connection, both the requesting app and the resource app must support the Connect with Okta App Feature.

Retrieve all Cross App Access connections
Early AccessIdentity Engine
OAuth 2.0 scopes:
  • okta.apps.read

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

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
Responses
200

Success

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/apps/{appId}/cwo/connections
Request samples 
Response samples 
application/json
[
  • {
    • "created": "2024-10-15T10:30:00.000Z",
    • "id": "cwofxqCAJWWGELFTYASJ",
    • "lastUpdated": "2024-10-15T14:20:00.000Z",
    • "requestingAppInstanceId": "0oafxqCAJWWGELFTYASJ",
    • "resourceAppInstanceId": "0oafxqCBJWWGELFTYASK",
    • "status": "ACTIVE"
    }
]
Create a Cross App Access connection
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.apps.manage
Creates a Cross App Access connection


Request 
path Parameters
appId
required
string
Application ID


 
 Example:  0oafxqCAJWWGELFTYASJ
Request Body schema: application/json
required
requestingAppInstanceId
string
ID of the requesting app instance


 
resourceAppInstanceId
string
ID of the resource app instance


 
status
string
Indicates if the Cross App Access connection is active or inactive


 Enum: "ACTIVE" "INACTIVE"  
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/cwo/connections
Request samples 
application/json
{
  • "requestingAppInstanceId": "0oafxqCAJWWGELFTYASJ",
  • "resourceAppInstanceId": "0oafxqCBJWWGELFTYASK",
  • "status": "ACTIVE"
}
Response samples 
application/json
{
  • "created": "2024-10-15T10:30:00.000Z",
  • "id": "cwofxqCAJWWGELFTYASJ",
  • "lastUpdated": "2024-10-15T14:20:00.000Z",
  • "requestingAppInstanceId": "0oafxqCAJWWGELFTYASJ",
  • "resourceAppInstanceId": "0oafxqCBJWWGELFTYASK",
  • "status": "ACTIVE"
}
Retrieve a Cross App Access connection
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.apps.read
Retrieves the Cross App Access connection with the specified ID


Request 
path Parameters
appId
required
string
Application ID


 
 Example:  0oafxqCAJWWGELFTYASJ
connectionId
required
string
Connection ID


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
200
Success


401
Unauthorized


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/cwo/connections/{connectionId}
Request samples 
Response samples 
application/json
{
  • "created": "2024-10-15T10:30:00.000Z",
  • "id": "cwofxqCAJWWGELFTYASJ",
  • "lastUpdated": "2024-10-15T14:20:00.000Z",
  • "requestingAppInstanceId": "0oafxqCAJWWGELFTYASJ",
  • "resourceAppInstanceId": "0oafxqCBJWWGELFTYASK",
  • "status": "ACTIVE"
}
Update a Cross App Access connection
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.apps.manage
Updates the Cross App Access connection with the specified ID


Request 
path Parameters
appId
required
string
Application ID


 
 Example:  0oafxqCAJWWGELFTYASJ
connectionId
required
string
Connection ID


 
 Example:  0oafxqCAJWWGELFTYASJ
Request Body schema: application/json
required
status
required
string
Requested value of Cross App Access connection status


 Enum: "ACTIVE" "INACTIVE"  
Responses 
200
Success


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


429
Too Many Requests


patch/api/v1/apps/{appId}/cwo/connections/{connectionId}
Request samples 
application/json
{
  • "status": "ACTIVE"
}
Response samples 
application/json
{
  • "created": "2024-10-15T10:30:00.000Z",
  • "id": "cwofxqCAJWWGELFTYASJ",
  • "lastUpdated": "2024-10-15T14:20:00.000Z",
  • "requestingAppInstanceId": "0oafxqCAJWWGELFTYASJ",
  • "resourceAppInstanceId": "0oafxqCBJWWGELFTYASK",
  • "status": "ACTIVE"
}
Delete a Cross App Access connection
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.apps.manage
Deletes a Cross App Access connection with the specified ID


Request 
path Parameters
appId
required
string
Application ID


 
 Example:  0oafxqCAJWWGELFTYASJ
connectionId
required
string
Connection ID


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
204
No Content


401
Unauthorized


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/apps/{appId}/cwo/connections/{connectionId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000011",
  • "errorSummary": "Invalid token provided",
  • "errorLink": "E0000011",
  • "errorId": "sampleQPivGUj_ND5v78vbYWW",
  • "errorCauses": [ ]
}