integrations

Get Integration

Get integration for the specified provider.

get/workspaces/{workspace_id}/integrations/{provider_id}

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required
provider_idstring required

Query parameters

grant_type'authorization_code' | 'client_credentials'

Grant type for OAuth 2.0.

Response

Successful Response

idstring uuid4 required
created_atstring date-time required
updated_atstring date-time required
user_idstring uuid nullable
provider_idstring required
authorization_endpointstring nullable

OAuth authorization endpoint configured for this integration.

token_endpointstring nullable

OAuth token endpoint configured for this integration.

token_typestring required
expires_atstring date-time nullable required
client_idstring nullable

OAuth client ID for the provider

granted_scopesstring[] nullable

OAuth scopes granted for this integration

requested_scopesstring[] nullable

OAuth scopes requested by user for this integration

status'not_configured' | 'configured' | 'connected' | 'reauth_required' required

Status of an integration.

is_expiredboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.