SimplaixSimplaix Gateway
Reference

Credentials

User credential vault APIs, including resolve/check endpoints for runtimes.

Endpoint Map

MethodPathAuthPurpose
GET/api/v1/credentialsFlexible authList current user credentials
DELETE/api/v1/credentials/:idFlexible authDelete owned credential
POST/api/v1/credentials/jwtFlexible authStore JWT credential
POST/api/v1/credentials/apikeyFlexible authStore API key credential
GET/api/v1/credentials/oauth/:serviceType/authFlexible authOAuth auth URL (currently placeholder)
GET/api/v1/credentials/oauth/:serviceType/callbackFlexible authOAuth callback (currently placeholder)
POST/api/v1/credentials/resolveFlexible auth + scope checkResolve multiple service credentials
GET/api/v1/credentials/check/:serviceTypeFlexible auth + scope checkCheck if credential exists for service

When using API key auth on resolve/check, key must include credentials:resolve scope.

Store JWT Credential

POST /api/v1/credentials/jwt
Authorization: Bearer <jwt>
Content-Type: application/json

{
  "serviceType": "gateway_api",
  "token": "<jwt-or-token>",
  "expiresAt": "2026-04-01T00:00:00.000Z"
}

Store API Key Credential

POST /api/v1/credentials/apikey
Authorization: Bearer <jwt>
Content-Type: application/json

{
  "serviceType": "slack",
  "apiKey": "xoxb-..."
}

Resolve Credentials

POST /api/v1/credentials/resolve
X-Api-Key: gk_xxx
X-User-Id: usr_123
Content-Type: application/json

{
  "serviceTypes": ["gateway_api", "slack"]
}
{
  "credentials": {
    "gateway_api": "...",
    "slack": "..."
  },
  "missing": [],
  "authUrls": {}
}

Check Credential for One Service

GET /api/v1/credentials/check/gateway_api
X-Api-Key: gk_xxx
X-User-Id: usr_123

Returns hasCredential plus metadata, or authUrl when missing.

OAuth Endpoints

/oauth/:serviceType/auth and /oauth/:serviceType/callback currently return 501 placeholder responses.

On this page