Potential Connections

The Potential Connections API provides operations that allow you to discover resources for AI agent connections. See Manage AI agents.

Note: This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Okta for AI Agents is available in Early Access. Contact Okta Support for more information.

List all potential connections
Beta
OAuth 2.0 scopes:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN

Lists all global resource connections of a specific connection type that an AI agent can potentially connect to

Only resource connections returned from this request are valid for creating a connection with a matching connection-type protocol.

Include the required filter query parameter to return potential connections with a specific connectionType. You can also use the match query parameter to apply fuzzy-matching on the returned list of potential connections.

Request
query Parameters
filter
required
string <scim-filter>

A required filter expression to return a specific type of potential connections.

The expression supports the eq operator and the following connectionType values:

  • IDENTITY_ASSERTION_CUSTOM_AS
  • STS_VAULT_SECRET
  • STS_SERVICE_ACCOUNT

You can combine multiple expressions using the and operator to narrow results. For example, filter by connection type and app instance ORN for STS_SERVICE_ACCOUNT connections.

Note: Query parameter percent encoding is required. See Special characters.

Examples:
Query param: ?filter=connectionType eq "IDENTITY_ASSERTION_CUSTOM_AS"
filter=connectionType%20eq%20%22IDENTITY_ASSERTION_CUSTOM_AS%22
Query param: ?filter=connectionType eq "STS_VAULT_SECRET"
filter=connectionType%20eq%20%22STS_VAULT_SECRET%22
Query param: ?filter=connectionType eq "STS_SERVICE_ACCOUNT"
filter=connectionType%20eq%20%22STS_SERVICE_ACCOUNT%22
Query param: ?filter=connectionType eq "STS_SERVICE_ACCOUNT" and appInstanceOrn eq "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4"
filter=connectionType%20eq%20%22STS_SERVICE_ACCOUNT%22%20and%20appInstanceOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o1n8sbwArJ7OQRw406%3Aapps%3Aslack%3A0oa1gjh63g214q0Hq0g4%22
match
string [ 3 .. 50 ] characters

A case-insensitive substring for fuzzy-match that's prefix-friendly

Example: match=agent
after
string

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination and Link header.

limit
integer [ 1 .. 200 ]
Default: 20

A limit on the number of objects to return

Responses
200

OK

400

Bad Request

403

Forbidden

get/workload-principals/api/v1/potential-connections
Request samples 
Response samples 
application/json
{}