SKskilljar
Scopes

List scope catalog + presets

Changed on

Return a page of API v2 scopes, ordered by codename, plus preset bundles.

No database access is performed — the catalog is the in-memory ALL_SCOPES constant, not the ApiScope coordinator rows, so it is paginated in memory. Requires clients:read because anyone who can view API clients needs access to the scope catalog.

query is declared for the OpenAPI contract only — the paginator reads the params off request.GET.

Required OAuth scope: clients:read

get/v2/scopes/

Request

Query parameters

page[size]integer

Maximum number of records to return. Values above 100 are served as 100; values below 1 are served as 1.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

Response

OK

Changes

  • bed169429eb2Revision changes
    • info

      added the new optional query request parameter page[cursor]

    • info

      added the new optional query request parameter page[size]

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional 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

  • 9fc34e55336dRevision changes
    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status