List 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
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
credential-definitions:read
Query parameters
limitintegerThe most items in the page: 1 to 100, default 20. Another value gives HTTP 400.
From 1 to 100.
Default:
20cursorstringThe
nextCursorof 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 withoffset(HTTP 400).offsetintegerHow many items come before the page: 0 to 10000. Use it only to jump to a page of a pager, then continue with the
nextCursorof the answer. Do not send it withcursor(HTTP 400). Another value gives HTTP 400.From 0 to 10000.
includeTotal booleantrue: the answer also hastotalandtotalCapped, the number of items of the filtered list. Send it on the first page only, for a pager. Defaultfalse. Another value gives HTTP 400.Default:
falsesearchstringGives 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
One page of the scopes.
itemsobject[]The scopes of the page, newest first.
nextCursor string | nullThe cursor of the next page, or
nullon the last page.totalintegerThe number of items of the filtered list, at most 10000. Only with
includeTotal=true. When the list has more items, the value is 10000 andtotalCappedistrue.From 0 to 10000.
Example:
137totalCapped booleantruewhen the filtered list has more than 10000 items:totalthen shows 10000. Only withincludeTotal=true.Example:
false