List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=, ?group= (keys bound to a group; a `user:<sub>` leaf's keys are one person's). Paginate: ?limit=, ?cursor= (opaque)

Changed on
get/api/v1/admin/keys

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Query parameters

enabledstring

Filter by enabled state (true|false)

prefixstring

Filter by key-id prefix

groupstring

Filter by bound group (a user:<sub> leaf's keys are one person's)

limitstring

Page size (default 200, max 1000)

cursorstring

Opaque continuation cursor from next_cursor

includestring

Set to tombstoned to include hard-deleted keys, which are otherwise omitted (each row's state reads "tombstoned")

Response

{items, next_cursor}: the cursor page envelope (next_cursor null at end)

next_cursorstring nullable required

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      api operation id GetKeys was added

    • info

      added the new optional query request parameter group

    • info

      added the new optional query request parameter include

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status