> For the complete documentation index, see [llms.txt](https://vectis.liesware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vectis.liesware.com/permissions.md).

# Permissions

## List effective API key permissions loaded in memory

> Administrative endpoint requiring root or an admin client. Returns active clients loaded from the signed config, redacts apikey\_hash, and does not read VECTIS\_CONFIG\_PATH directly.

```json
{"openapi":"3.1.0","info":{"title":"Vectis HTTP API","version":"v1"},"tags":[{"name":"Permissions"}],"servers":[{"url":"http://127.0.0.1:3000","description":"Local default server over HTTP"},{"url":"https://127.0.0.1:3000","description":"Local HTTPS server when VECTIS_MODE=prod"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"PermissionsOutput":{"type":"object","required":["clients"],"properties":{"clients":{"type":"array","items":{"$ref":"#/components/schemas/PermissionClientOutput"}}}},"PermissionClientOutput":{"type":"object","required":["client","admin","permissions"],"properties":{"client":{"$ref":"#/components/schemas/TextField"},"admin":{"type":"boolean"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/KidPermissionOutput"}}}},"TextField":{"type":"string","minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F-\\x9F]+$"},"KidPermissionOutput":{"type":"object","required":["kid","actions"],"properties":{"kid":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["admin","keys","lifecycle","self-test","sign","message","symmetric","fpe-encrypt","fpe-decrypt","token-encode","token-decode","token-delete","token-deterministic-encode","token-deterministic-decode","subject-create","subject-delete","mac-create","mac-verify","commit-create","commit-verify","share-split","share-combine","index-create","index-verify","mask","time-attest","metrics"]}}}},"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/TextField"}}}},"responses":{"Error":{"description":"Public error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/permissions":{"get":{"tags":["Permissions"],"summary":"List effective API key permissions loaded in memory","description":"Administrative endpoint requiring root or an admin client. Returns active clients loaded from the signed config, redacts apikey_hash, and does not read VECTIS_CONFIG_PATH directly.","responses":{"200":{"description":"Redacted active permission clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsOutput"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```