Skip to main content
Keys

List keys

GET/v4/config/ows/key-management/keys

Lists one page of the signing keys of the organisation, from all key stores or from one. Use it to choose the key (its keyId) that a credential definition, a presentation definition or a configuration signs with. The wallet signs credentials, status lists, signed issuer metadata and OpenID4VP requests with these keys.

Each key has its key store, its public JWK, its certificate assessment, and in usage the credential and presentation definitions that sign with it, with their number (Read key usage gives the details). The answer has public values only. Retired keys are not in the list, and neither is the wallet key of the organisation while it has no certificate chain.

Filter with keyStoreId, search, withCertificateChain, purpose (the suggested keys of a use) and certificatePreset (the keys of one certificate preset, or none for the keys with a certificate chain and no preset), order with sortBy and sortOrder (default: the last changed key first), and page with limit and offset. An offset past the end gives the last page. A sandbox organisation gets the keys of its main organisation; the search and the counts cover the definitions of the main organisation and its sandbox organisations.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:keys:read

Query parameters

  • keyStoreIdstring

    Keeps the keys of one key store. Default all key stores.

    At most 64 characters.

    Example:"local-openbao"

  • searchstring

    Keeps the keys whose key ID or name contains the text, and the keys that sign for a credential or presentation definition whose name or ID contains the text. Case insensitive; an ID also matches without its hyphens. At most 128 characters.

    At most 128 characters.

  • withCertificateChainboolean

    With true, keeps only the keys that have an X.509 certificate chain (the keys that can sign with cryptographicKeyFormat x509). Default false.

    Default:false

  • purposeenum<string>

    Keeps the suggested keys of this use: the keys with an X.509 certificate chain and a certificate preset that the use accepts, or no certificate preset. signingPurposes of List certificate presets gives the presets of each use. It is a filter of a key picker, not a rule of a save: a save does not refuse a key because of its certificate preset.

    Available options:credential-pid,credential-eaa,credential-qeaa,credential-pub-eaa,credential-pid-mdoc,credential-eaa-mdoc,credential-qeaa-mdoc,credential-pub-eaa-mdoc,credential-mdl,status-list,status-list-mdoc,wallet-provider,verifier-x509-hash,verifier-x509-san-dns,verifier-attestation,annex-c-reader,issuer-metadata

  • certificatePresetenum<string>

    Keeps the keys with this certificate preset: a preset id of List certificate presets, or none for the keys that have an X.509 certificate chain and no certificate preset. Another value gives 400.

    Available options:wrpac-legal,wrpac-natural,pid-provider,wallet-provider,wallet-status-list-signer,eaa-provider,qeaa-provider,pub-eaa-provider,mdoc-document-signer,pid-provider-mdoc,eaa-provider-mdoc,qeaa-provider-mdoc,pub-eaa-provider-mdoc,mdoc-reader,mdoc-status-list-signer,status-list-signer,request-signer-san-dns,custom,none

    Example:"eaa-provider"

  • sortByenum<string>

    The order of the keys. Default updatedAt (the last changed key first). With name, keys without a name come last in both directions. The key ID breaks ties, so the order is stable from page to page.

    Available options:name,createdAt,updatedAt

    Default:updatedAt

  • sortOrderenum<string>

    Ascending or descending. Default asc for sortBy name, desc for the times.

    Available options:asc,desc

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

Response

application/json

One page of the keys of the organisation.

  • keysobject[]

    The keys of the page. An empty list when no key matches the filters.

  • paginationobject

    The page of the key list.