Skip to content

Retrieve an AI agent provider

Request

Beta
OAuth 2.0 scope:
  • okta.aiAgents.read
Admin roles:
  • SUPER_ADMIN

Retrieves an AI agent provider

Path
providerIdstringrequired

ID of the AI agent provider

Example:aip-1a2b3c4d
Query
expandstring

Valid value: profileMapping. If specified, the provider's profile mapping is included in the _embedded attribute.

Example:expand=profileMapping
curl -i -X GET \
  'https://subdomain.okta.com/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d?expand=profileMapping'

Responses

A successful response for getting an AI agent provider

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
configurationobject(Configuration)

Provider-specific configuration used to connect to the AI agent provider and import agents. The properties depend on the type of the source.

idstring, non-emptyrequired

The ID of the AI agent provider

integrationDatestring, (date-time)

The date and time when the AI agent provider was integrated

lastImportDatestring, (date-time)

The date and time when the last import from the AI agent provider occurred

nextScheduledImportDatestring, (date-time)

The date and time of the next scheduled import from the AI agent provider

ownersobject(Owners)
scheduleobject(Schedule)
sourceIdstring, = 20 charactersrequired

The ID of the source

sourceNamestring, [ 1 .. 255 ] charactersrequired

The name of the source

sourceOrnstringrequired

The ORN of the source

sourceTypestring, [ 1 .. 10 ] charactersrequired

The type of the source

statusstring(AIAgentProviderStatus)required

The status of the AI agent provider

Enum:"ACTIVE""INACTIVE""REAUTHENTICATE""REVALIDATE"
stagestring(AIAgentProviderStage)

Preview option to unify identity for imported agents. If not provided, the default behavior is to import agents as AUTO_MERGE.

Enum:"AUTO_MERGE""DUPLICATE""NEWLY_IMPORTED"
deDupExpressionstring(AIAgentProviderDeDupExpression)

Expression to uniquely identify imported agents. If not provided, the default behavior is to use the agent's external ID as the unique identifier. Custom values beyond the listed enum are also accepted.

Enum:"target.profile.externalId eq source.profile.externalId""target.profile.externalId eq source.profile.externalId and target.profile.platform eq source.profile.platform""target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name""target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name and target.profile.platform eq source.profile.platform"
Example:"target.profile.externalId eq source.profile.externalId"
importInProgressboolean

Whether an import job for this provider is currently queued or running.

Example:true
_embeddedobject(AIAgentProviderEmbedded)

Embedded resources for an AI agent provider. Only present when the corresponding expand value was requested.

Response
{ "id": "id", "sourceOrn": "orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ", "sourceId": "appId", "sourceName": "Salesforce", "sourceType": "apps", "status": "ACTIVE", "integrationDate": "2024-01-01T12:00:00Z", "lastImportDate": "2024-06-01T12:00:00Z", "owners": { "userOrns": [ … ] }, "_links": { "self": { … } } }