{"openapi":"3.1.0","info":{"title":"GET /api/v1/api-clients","version":"1.0.0","description":"List API clients"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/api-clients":{"get":{"tags":["api-clients"],"summary":"List API clients","description":"The caller's partner API clients, the token endpoint they use, the accepted assertion audiences, and whether mTLS is available.","operationId":"list_api_clients","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ApiClientListResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_api_clients_api_v1_api_clients_get"}}},"components":{"schemas":{"ApiClientListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ApiClientResponse"},"type":"array","title":"Items"},"mtls_available":{"type":"boolean","title":"Mtls Available","description":"Whether require_mtls can be turned on in this environment"},"token_endpoint":{"type":"string","title":"Token Endpoint","description":"URL partners post assertions to"},"assertion_audiences":{"items":{"type":"string"},"type":"array","title":"Assertion Audiences","description":"Accepted values for the assertion's aud claim"},"max_clients":{"type":"integer","title":"Max Clients"}},"type":"object","required":["items","mtls_available","token_endpoint","assertion_audiences","max_clients"],"title":"ApiClientListResponse","description":"The caller's API clients plus what a partner needs to call the token endpoint."},"ApiClientResponse":{"properties":{"id":{"type":"string","title":"Id"},"client_id":{"type":"string","title":"Client Id","description":"Put this in iss and sub of assertions"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","enum":["active","disabled"],"title":"Status"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"allowed_ips":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Ips"},"rate_limit_per_minute":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate Limit Per Minute"},"token_ttl_seconds":{"type":"integer","title":"Token Ttl Seconds"},"jwks":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Jwks","description":"Registered public keys"},"key_ids":{"items":{"type":"string"},"type":"array","title":"Key Ids"},"require_mtls":{"type":"boolean","title":"Require Mtls"},"mtls_cert_thumbprints":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Mtls Cert Thumbprints"},"require_signed_requests":{"type":"boolean","title":"Require Signed Requests"},"signing_keys":{"items":{"$ref":"#/components/schemas/ApiClientSigningKeyResponse"},"type":"array","title":"Signing Keys"},"active_token_count":{"type":"integer","title":"Active Token Count","description":"Unexpired, unrevoked access tokens issued to the client","default":0},"last_token_issued_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Token Issued At"},"disabled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Disabled At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"mtls_available":{"type":"boolean","title":"Mtls Available","description":"Whether this environment forwards client certificates. When false, require_mtls cannot be turned on."}},"type":"object","required":["id","client_id","name","status","scopes","token_ttl_seconds","require_mtls","require_signed_requests","created_at","mtls_available"],"title":"ApiClientResponse","description":"An API client's settings. Contains no secrets."},"ApiClientSigningKeyResponse":{"properties":{"kid":{"type":"string","title":"Kid"},"alg":{"type":"string","title":"Alg"},"public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key","description":"Ed25519 public key (base64); null for HMAC keys"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"retired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Retired At","description":"When the key stops verifying requests"},"status":{"type":"string","enum":["active","retiring","retired"],"title":"Status"}},"type":"object","required":["kid","alg","status"],"title":"ApiClientSigningKeyResponse","description":"A signing key as the owner sees it: never the secret."},"SuccessEnvelope_ApiClientListResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/ApiClientListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ApiClientListResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}