AuthSpokeAuthSpoke Developers
Enterprise Connectors Β· API Reference

Integrations Workspace

The metadata-driven connector workspace: configuration, provisioning, diagnostics, activity, operations, synchronization, and reliability.

GET/api/v1/integrations

List v1 integrations

List v1 integrations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
PATCH/api/v1/integrations/{id}

Update integrations id

Update integrations id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X PATCH "https://api.authspoke.com/api/v1/integrations/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
DELETE/api/v1/integrations/{id}

Delete integrations id

Delete integrations id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

204Deleted or completed with no response body.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X DELETE "https://api.authspoke.com/api/v1/integrations/{id}" \
  -H "Authorization: Bearer $TOKEN"
GET/api/v1/integrations/{id}/activity

List activity

List activity in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/activity" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/activity/{eventId}

Get activity event

Get activity event in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
eventId*eventId identifier.

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/activity/{eventId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/activity/summary

Get summary

Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/activity/summary" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/configuration

Get id configuration

Get id configuration in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/configuration" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
PUT/api/v1/integrations/{id}/configuration

Replace id configuration

Replace id configuration in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X PUT "https://api.authspoke.com/api/v1/integrations/{id}/configuration" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/configuration/validate

Create or run configuration validate

Create or run configuration validate in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/configuration/validate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/diagnostics/history

List history

List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/diagnostics/history" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/diagnostics/latest

Get diagnostics latest

Get diagnostics latest in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/diagnostics/latest" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/diagnostics/run

Create or run diagnostics run

Create or run diagnostics run in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/diagnostics/run" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/diagnostics/runs/{runId}

Get runs run id

Get runs run id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
runId*runId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/diagnostics/runs/{runId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/health/trend

Get health

Get health in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/health/trend" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/import

Create or run id import

Create or run id import in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/import" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/imports

Create or run id imports

Create or run id imports in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/imports" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/imports/{importId}

Get imports import id

Get imports import id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
importId*importId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/imports/{importId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/imports/{importId}/confirm

Confirm operation

Confirm operation in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
importId*importId identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/imports/{importId}/confirm" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/imports/{importId}/preview

Get preview

Get preview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
importId*importId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/imports/{importId}/preview" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/imports/history

List history

List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/imports/history" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/operations

Get id operations

Get id operations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/operations" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/operations

Create or run id operations

Create or run id operations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/operations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/operations/{operationId}

Get operations operation id

Get operations operation id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
operationId*operationId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/operations/{operationId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/operations/{operationId}/cancel

Create or run operation id cancel

Create or run operation id cancel in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
operationId*operationId identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/operations/{operationId}/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/operations/{operationId}/retry

Create or run operation id retry

Create or run operation id retry in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
operationId*operationId identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/operations/{operationId}/retry" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/overview

Get id overview

Get id overview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/overview" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/refresh

Create or run id refresh

Create or run id refresh in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/refresh" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/reliability/summary

Get summary

Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/reliability/summary" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
PUT/api/v1/integrations/{id}/schedule

Replace id schedule

Replace id schedule in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X PUT "https://api.authspoke.com/api/v1/integrations/{id}/schedule" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/synchronizations

Create or run id synchronizations

Create or run id synchronizations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/synchronizations/{syncId}

Get synchronizations sync id

Get synchronizations sync id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
syncId*syncId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations/{syncId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/synchronizations/{syncId}/confirm

Confirm operation

Confirm operation in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
syncId*syncId identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations/{syncId}/confirm" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/synchronizations/{syncId}/preview

Get preview

Get preview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.
syncId*syncId identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations/{syncId}/preview" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/synchronizations/history

List history

List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations/history" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/synchronizations/latest

Get synchronizations latest

Get synchronizations latest in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/synchronizations/latest" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/integrations/{id}/test

Test connection

Test connection in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/integrations/{id}/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configuration":{"mode":"metadata-driven"}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/{id}/workspace

Get id workspace

Get id workspace in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/{id}/workspace" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/filters

List integrations filters

List integrations filters in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/filters" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/integrations/summary

Get summary

Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

πŸ”’ Bearer JWT required

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/integrations/summary" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}