Skip to main content
Templates and catalogues

List scopes

GET/v4/config/ows/issuer/scopes

Lists the OAuth 2.0 scopes of the organisation, newest first, one page at a time. Each credential configuration has a scope: its scope, else its credentialConfigurationId. A wallet can ask for a credential configuration with its scope in the authorisation request, and the Credential Issuer Metadata publishes it. Check this list before you give a configuration its own scope. To read the next page, send the nextCursor of the answer as cursor.

Send search to find the values that contain a text, and includeTotal=true to count them in total. For suggestions while an admin types, send search with a small limit, for example ?search=pid&limit=20.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:credential-definitions:read

Query parameters

  • limitinteger

    The most items in the page: 1 to 100, default 20. Another value gives HTTP 400.

    From 1 to 100.

    Default:20

  • cursorstring

    The nextCursor of the page before, to read the next page. Leave it out for the first page. Use it as it is: a changed cursor gives HTTP 400. Do not send it with offset (HTTP 400).

  • offsetinteger

    How many items come before the page: 0 to 10000. Use it only to jump to a page of a pager, then continue with the nextCursor of the answer. Do not send it with cursor (HTTP 400). Another value gives HTTP 400.

    From 0 to 10000.

  • includeTotalboolean

    true: the answer also has total and totalCapped, the number of items of the filtered list. Send it on the first page only, for a pager. Default false. Another value gives HTTP 400.

    Default:false

  • searchstring

    Gives only the scope values that contain this text. The search does not use the case of the letters, and % and _ are plain characters. The spaces at the start and the end of the text are removed; a blank text is no filter. The list stays newest first.

Response

application/json

One page of the scopes.

  • itemsobject[]

    The scopes of the page, newest first.

  • nextCursorstring | null

    The cursor of the next page, or null on the last page.

  • totalinteger

    The number of items of the filtered list, at most 10000. Only with includeTotal=true. When the list has more items, the value is 10000 and totalCapped is true.

    From 0 to 10000.

    Example:137

  • totalCappedboolean

    true when the filtered list has more than 10000 items: total then shows 10000. Only with includeTotal=true.

    Example:false