Application Connections

The Application Connections API provides operations for configuring connections to an app.

Currently, only the Okta Org2Org app provisioning connection is supported in this API.

Retrieve the default Provisioning Connection
OAuth 2.0: okta.apps.read

Retrieves the default Provisioning Connection for an app

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/apps/{appId}/connections/default
Request samples
Response samples
application/json
{}

Update the default Provisioning Connection
OAuth 2.0: okta.apps.manage

Updates the default Provisioning Connection for an app

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
query Parameters
activate
boolean

Activates the Provisioning Connection

Request Body schema: application/json
required
required
object (ProvisioningConnectionProfile)

The profile used to configure the connection method of authentication and the credentials. Currently, token-based and OAuth 2.0-based authentication are supported.

authScheme
required
string (ProvisioningConnectionAuthScheme)

Defines the method of authentication

token
required
string

Token used to authenticate with the app

Responses
201

Created

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/apps/{appId}/connections/default
Request samples
application/json
{
  • "profile": {
    • "authScheme": "TOKEN",
    • "token": "00NgAPZqUVy8cX9ehNzzahEE5b-On9sImTcInvWp-x"
    }
}
Response samples
application/json
{}

Activate the default Provisioning Connection
OAuth 2.0: okta.apps.manage

Activates the default Provisioning Connection for an app

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/apps/{appId}/connections/default/lifecycle/activate
Request samples
Response samples
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}

Deactivate the default Provisioning Connection
OAuth 2.0: okta.apps.manage

Deactivates the default Provisioning Connection for an app

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/apps/{appId}/connections/default/lifecycle/deactivate
Request samples
Response samples
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}