Enterprise Connectors · API Reference

Legacy Catalog

Legacy catalog and catalog-instance APIs retained for compatibility.

GET/api/v1/catalog

List v1 catalog

List v1 catalog 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/catalog" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/catalog/categories

List catalog categories

List catalog 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/catalog/categories" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/catalog/instances

List catalog instances

List catalog instances 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/catalog/instances" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/catalog/instances

Create or run catalog instances

Create or run catalog instances 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

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/catalog/instances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/catalog/instances/{id}

Get instances id

Get instances id 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

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/catalog/instances/{id}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

PUT/api/v1/catalog/instances/{id}

Replace instances id

Replace instances id 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

id*	id 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

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/catalog/instances/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

DELETE/api/v1/catalog/instances/{id}

Delete instances id

Delete instances id 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

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/catalog/instances/{id}" \
  -H "Authorization: Bearer $TOKEN"

GET/api/v1/catalog/instances/{id}/assets

Get id assets

Get id assets 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

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/catalog/instances/{id}/assets" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/catalog/instances/{id}/audit

Get id audit

Get id audit 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

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/catalog/instances/{id}/audit" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/catalog/instances/{id}/capabilities

Get id capabilities

Get id capabilities 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

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/catalog/instances/{id}/capabilities" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/catalog/instances/{id}/discover

Create or run id discover

Create or run id discover 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

id*	id 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/catalog/instances/{id}/discover" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/catalog/instances/{id}/health

Get health

Get health 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

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/catalog/instances/{id}/health" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/catalog/instances/{id}/import

Create or run id import

Create or run id import 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

id*	id 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/catalog/instances/{id}/import" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

POST/api/v1/catalog/instances/{id}/test-connection

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

id*	id 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/catalog/instances/{id}/test-connection" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/catalog/instances/pipeline

List instances pipeline

List instances pipeline 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/catalog/instances/pipeline" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/catalog/instances/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

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/catalog/instances/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/catalog/registry

List catalog registry

List catalog registry 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/catalog/registry" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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