FruxonDocs
IntegrationsCore

Initiates an OAuth flow for application-level (agent-level) integration auth

Used when the agent builder wants to connect an OAuth account during agent setup, so that all users of the agent share the same credentials. After the user authorizes, the OAuth callback stores credentials temporarily. Use `:consumeOAuthCredentials` to finalize and create the auth record.

POST
/v1/tenants/{tenant}/integrations/{integration}:authorize

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

integration*string

The integration ID.

tenant*string

The tenant identifier

Request Body

The auth method to authorize.

integrationAuthMetadataId*string

The auth method to authorize (e.g. "oauth2").

Length1 <= length
configParameters?|null

Optional integration config parameters for URL placeholder resolution (e.g. instance URL for Salesforce OAuth).

scopes?|null

Scopes the admin selected from the auth method's AvailableScopes catalog. When unset or empty, the server uses OAuth2Settings.DefaultScopes instead.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string:authorize" \  -H "Content-Type: application/json" \  -d '{    "integrationAuthMetadataId": "string"  }'
{
  "authorizationUrl": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty

Lists integrations in the workspace, paginated.

Returns a page of configured integrations, each annotated with its tool count. Use the `search`, `types`, and `tags` query parameters to filter server-side, and `page_size`/`page_token` to page through results. The full tool collection for an integration is fetched separately via `/integrations/{integration}/tools`.

Consumes temporarily stored OAuth credentials from a completed application-level OAuth flow and creates an `IntegrationAuth` record bound to the specified integration config.

The credential key is returned to the frontend via the OAuth success redirect after the user completes authorization. The resulting connection is shared by every agent that references the target config. The credential key is single-use.