Enterprise Connectors · API Reference

Connector Catalog

Browse connector definitions, manifests, statuses, categories, and draft connection tests.

GET/api/v1/connectors

List v1 connectors

List v1 connectors for the Enterprise Connector Framework. 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

page	Zero-based page index where supported.
size	Page 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/connectors" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/connectors/{providerKey}

Get connectors provider key

Get connectors provider key for the Enterprise Connector Framework. 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

providerKey*

providerKey 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/connectors/{providerKey}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/connectors/{providerKey}/manifest

Get provider key manifest

Get provider key manifest for the Enterprise Connector Framework. 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

providerKey*

providerKey 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/connectors/{providerKey}/manifest" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/connectors/{providerKey}/test

Test connection

Test connection for the Enterprise Connector Framework. 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

providerKey*

providerKey identifier.

Request body

name	string	Display name or operation name where applicable.
status	string	Status or lifecycle value where applicable.
reason	string	Audit reason for governed changes.
metadata	object	Provider or business metadata.
configuration	object	Connector, 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/connectors/{providerKey}/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/connectors/categories

List connectors categories

List connectors categories for the Enterprise Connector Framework. 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

page	Zero-based page index where supported.
size	Page 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/connectors/categories" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/connectors/enabled

List connectors enabled

List connectors enabled for the Enterprise Connector Framework. 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

page	Zero-based page index where supported.
size	Page 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/connectors/enabled" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/connectors/statuses

List connectors statuses

List connectors statuses for the Enterprise Connector Framework. 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

page	Zero-based page index where supported.
size	Page 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/connectors/statuses" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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