List credential definitions
Lists the credential definitions of the organisation, newest first, one page at a time. Each item is the credential definition as Read credential definition gives it (without definitionVersion), with issuanceCount, the number of its issuance histories. For the counts in buckets, use Read credential definition statistics. To read the next page, send the nextCursor of the answer as cursor. The list leaves out the deleted credential definitions.
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:
false
Response
One page of the credential definitions.
itemsobject[]The credential definitions of the page, newest first. Empty when the organisation has no credential definition.
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