Provider · API Reference

Provider Support

AuthSpoke provider-admin operations for tenants, entitlements, kill switches, config, and support actions.

GET/api/v1/support/config

List support config

List support config. 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/support/config" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/support/config

Create or run support config

Create or run support config. 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/support/config" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

POST/api/v1/support/config/{key}

Create or run config key

Create or run config key. 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

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

Example response

JSON

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

DELETE/api/v1/support/config/{key}

Delete config key

Delete config key. 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

key*	key 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/support/config/{key}" \
  -H "Authorization: Bearer $TOKEN"

GET/api/v1/support/kill-switches

List support kill switches

List support kill switches. 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/support/kill-switches" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/support/kill-switches/{key}

Create or run kill switches key

Create or run kill switches key. 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

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

Example response

JSON

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

GET/api/v1/support/me

List support me

List support me. 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/support/me" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/support/orgs

List support orgs

List support orgs. 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/support/orgs" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/support/orgs/{tenantId}

Get orgs tenant id

Get orgs tenant id. 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

tenantId*

tenantId 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/support/orgs/{tenantId}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/support/orgs/{tenantId}/users

Get tenant id users

Get tenant id users. 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

tenantId*

tenantId 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/support/orgs/{tenantId}/users" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/support/sql

Create or run support sql

Create or run support sql. 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/support/sql" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

GET/api/v1/support/tenants

List support tenants

List support tenants. 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/support/tenants" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

GET/api/v1/support/tenants/{tenantId}/entitlements

Get tenant id entitlements

Get tenant id entitlements. 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

tenantId*

tenantId 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/support/tenants/{tenantId}/entitlements" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

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

POST/api/v1/support/tenants/{tenantId}/entitlements/{kind}/{key}

Create or run kind key

Create or run kind key. 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

tenantId*	tenantId identifier.
kind*	kind identifier.
key*	key 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/support/tenants/{tenantId}/entitlements/{kind}/{key}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

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

POST/api/v1/support/users/{userId}/reset-password

Create or run user id reset password

Create or run user id reset password. 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

userId*

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

Example response

JSON

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

POST/api/v1/support/users/{userId}/status

Create or run user id status

Create or run user id status. 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

userId*

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

Example response

JSON

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