Management keys

List management keys

Changed on

Returns management keys in the current workspace, ordered by creation time with the newest key first. The api_key and token_hash fields are never returned by this endpoint; only token_prefix is included.

get/v2/management-keys

Request

  • Base URL
    https://my.orq.ai
  • Auth
    HTTP bearer

Query parameters

limitinteger

Page size, 1–200. Unset uses the server default (25).

starting_afterstring

Cursor for forward pagination. Set to the management_key_id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the management_key_id of the first item from the previous page.

status'MANAGEMENT_KEY_STATUS_ACTIVE' | 'MANAGEMENT_KEY_STATUS_DISABLED' | 'MANAGEMENT_KEY_STATUS_REVOKED'

Optional filter: only return keys with this status.

searchstring

Optional case-insensitive substring match against the management-key name. Empty means no name filter.

permission_modeManagementPermissionMode[]

Optional filter: only return keys whose permission mode is one of the listed presets. Empty means no permission-mode filter.

Response

OK

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more management-keys are available in the selected pagination direction.

Changes

    • breaking

      removed the enum value MANAGEMENT_KEY_STATUS_UNSPECIFIED from the query request parameter status

    • breaking

      removed the enum value MANAGEMENT_PERMISSION_MODE_UNSPECIFIED from the property items/ of the query request parameter permission_mode

    • info

      added the non-success response with the status

    • info

      removed the MANAGEMENT_KEY_STATUS_UNSPECIFIED enum value from the // response property for the response status

    • info

      removed the MANAGEMENT_PERMISSION_MODE_UNSPECIFIED enum value from the // response property for the response status

    • warning

      added the new MANAGEMENT_KEY_STATUS_UNSPECIFIED enum value to the // response property for the response status

    • warning

      added the new MANAGEMENT_PERMISSION_MODE_UNSPECIFIED enum value to the // response property for the response status

    • info

      added the new enum value MANAGEMENT_KEY_STATUS_UNSPECIFIED to the query request parameter status

    • info

      added the enum value MANAGEMENT_PERMISSION_MODE_UNSPECIFIED to the property items/ of the query request parameter permission_mode

    • info

      removed the non-success response with the status