SimplaixSimplaix Gateway
Reference

Credential Providers

Admin APIs for credential-provider definitions (serviceType, authType, config).

Endpoint Map

MethodPathAuthPurpose
GET/api/v1/credential-providersJWT + provider:readList providers
POST/api/v1/credential-providersJWT + provider:createCreate provider
GET/api/v1/credential-providers/:idJWT + provider:readGet provider
PUT/api/v1/credential-providers/:idJWT + provider:updateUpdate provider
DELETE/api/v1/credential-providers/:idJWT + provider:deleteDelete provider
GET/api/v1/credential-providers/by-service/:serviceTypeJWT + provider:readResolve by service type (tenant-first fallback)

Create Provider

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

{
  "serviceType": "gateway_api",
  "name": "Gateway API",
  "authType": "jwt",
  "config": {
    "connectUrl": "/auth/connect?service=gateway_api",
    "jwt": { "headerName": "Authorization", "prefix": "Bearer " }
  }
}

Supported authType values: oauth2, api_key, jwt, basic.

Notes

  • serviceType must match ^[a-z][a-z0-9_]*$.
  • Read endpoints redact secret fields from provider config.
  • Update merges masked secrets ("********") with existing stored values.
  • Tenant scope is enforced by role and tenant context.

On this page