Skip to navigation

List capability presets

Lists the capability presets a user or invitation body’s preset names — each one’s name, its capabilities as scope strings, and what it grants — for a picker to fill a member’s capabilities from. Served to every admitted member as one document, never a page: a preset is a starting point, not a record, and no row names the one a member was given.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

Every preset, in the order a picker lists them. The position it was served at rides the two position headers, as on every read; the document does not move with it.

presetslist of objects
Every preset, in the order a picker lists them.

Errors

400
List Capability Presets Users Request Bad Request Error
401
List Capability Presets Users Request Unauthorized Error
403
List Capability Presets Users Request Forbidden Error
503
List Capability Presets Users Request Service Unavailable Error