Read key usage

GET 
/v2/config/digital-wallet/openid/key-management/keys/:keyId/usage

Reports where a key is in use: the credential definitions and presentation definitions that sign with it, the status lists of those credential definitions, the issuances and verifications in flight, and whether the key can be deleted. The items come last changed first.

The report reads the organisation and its sandbox organisations only: a definition of a sandbox organisation signs with the keys of its main organisation, and no other organisation can use the key. The delete key operation applies the same rule.

Request

Path Parameters

keyId stringrequired

Unique identifier of the key

Query Parameters

search stringrequired

Possible values: <= 128 characters

Keeps the credential and presentation definitions whose name or ID contains the text, and the status lists of the kept credential definitions. An ID also matches without its hyphens. Case insensitive, at most 128 characters. The in flight counts and canDelete always cover every use of the key.

Responses

200

The service returned the usage report of the key.

Response Headers

application/json

Schema

Schema

keyId stringrequired

Unique identifier of the key.

isDefault booleanrequired

Shows true when the wallet signs with this key by default.

hasCertificates booleanrequired

Shows true when a certificate chain is linked to the key.

credentialDefinitions objectrequired
Credential definitions that sign with the key.
count integer
Number of items.
items object[]
Array [
id string
Unique identifier of the credential definition.
label string
Name of the credential definition.
]
presentationDefinitions objectrequired
Presentation definitions that sign with the key.
count integer
Number of items.
items object[]
Array [
id string
Unique identifier of the presentation definition.
label string
Name of the presentation definition.
]
statusLists objectrequired
Status lists of the credential definitions that sign with the key.
count integer
Number of items.
items object[]
Array [
id string
Unique identifier of the status list.
credentialConfigurationId string
Identifier of the credential definition that the status list belongs to.
issuerUrl string
Issuer URL that the status list is published under.
]
issuanceRecordsInFlight objectrequired

Credential issuances that are under way with the key.

count integer

Number of issuances in flight.

verificationRecordsInFlight objectrequired

Verifications that are under way with the key.

count integer

Number of verifications in flight.

canDelete booleanrequired

Shows true when nothing uses the key, so the delete key operation accepts it.

Example (from schema)

{
  "keyId": "3f2a91c47b8d4e6fa0c5d7e18b924f30",
  "isDefault": false,
  "hasCertificates": true,
  "credentialDefinitions": {
    "count": 1,
    "items": [
      {
        "id": "7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c",
        "label": "Person Identification Data"
      }
    ]
  },
  "presentationDefinitions": {
    "count": 1,
    "items": [
      {
        "id": "9d1f3b5a7c2e4f6a8b0c1d2e3f4a5b6c",
        "label": "Age over 18"
      }
    ]
  },
  "statusLists": {
    "count": 1,
    "items": [
      {
        "id": "2b4d6f8a0c1e4f6a8b0c1d2e3f4a5b6c",
        "credentialConfigurationId": "7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c",
        "issuerUrl": "https://demo-api.igrant.io/organisation/5f9a1b2c3d4e5f60718293a4/service"
      }
    ]
  },
  "issuanceRecordsInFlight": {
    "count": 0
  },
  "verificationRecordsInFlight": {
    "count": 0
  },
  "canDelete": false
}

400

The search text is longer than 128 characters.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no key with this key ID.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...