Get Started · API Reference

Authentication

GET/api/v1/auth/ping

List auth ping

List auth ping. This endpoint is public unless deployment policy requires otherwise.

Public — no auth

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/auth/ping"

Example response

JSON

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

POST/api/v1/auth/reset-password

Change your password

Authenticated self-service password change. Requires a bearer token; the target user is the token's principal (never a body username). The current password must verify.

🔒 Bearer JWT required

Request body

currentPassword*	string
newPassword*	string

Responses

200Password changed

400Current password incorrect / weak new password

401Unauthenticated

Example request

cURL

curl -X POST "https://api.authspoke.com/api/v1/auth/reset-password" \
  -H "Authorization: Bearer $TOKEN"

POST/api/v1/auth/signin

Create or run auth signin

Create or run auth signin. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

Public — no auth

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/auth/signin" \
  -H "Content-Type: application/json" \
  -d '{"username":"[email protected]","password":"********"}'

Example response

JSON

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

POST/api/v1/email/send-otp

Create or run email send otp

Create or run email send otp. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

Public — no auth

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/email/send-otp" \
  -H "Content-Type: application/json" \
  -d '{"username":"[email protected]","password":"********"}'

Example response

JSON

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

POST/api/v1/email/verify-otp

Create or run email verify otp

Create or run email verify otp. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

Public — no auth

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/email/verify-otp" \
  -H "Content-Type: application/json" \
  -d '{"username":"[email protected]","password":"********"}'

Example response

JSON

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

POST/api/v1/auth/token

Token

Public — no auth

Request body

Responses

200Success

Example request

cURL

curl -X POST "https://api.authspoke.com/api/v1/auth/token"