Read organisation identifier

GET 
/v2/config/digital-wallet/openid/organisation-identifier

Reads the cryptographic identifiers of the organisation. The response groups the keys by secure vault and gives the public key and the DIDs of each key.

The service returns one entry for each supported vault, also when the vault holds no key. It returns a key only when the vault configuration is complete.

Responses

200

Organisation identifiers read successfully.

Response Headers

application/json

Schema

Schema

keyManagementServices object[]required
One entry for each supported secure vault, with the keys that the vault holds.
Array [
id integerrequired
Possible values: [1, 2, 3, 4]
Secure vault ID. 1 for the iGrant.io vault, 2 for the Hashicorp vault, 3 for the QTSP vault, 4 for the database backed vault.
name stringrequired
Possible values: [igrantioVault, hashicorpVault, qtsp, dbBackedVault]
Name of the secure vault.
keys object[]required
Keys that the vault holds. The list is empty when the vault holds no key or when the vault configuration is not complete.
Array [
isDefault booleanrequired
Shows true when the wallet signs with this key by default.
jwk objectrequired
Public key in JSON Web Key (JWK) format. The service adds the x5c field when a certificate chain is linked to the key.
kty string
Key type. The vault creates elliptic curve keys, so the value is EC.
crv string
Elliptic curve identifier. The vault uses the P-256 curve.
x string
X coordinate of the elliptic curve point, in base64url format.
y string
Y coordinate of the elliptic curve point, in base64url format.
kid string
Key identifier.
alg string
Signature algorithm for the key. The vault sets ES256.
x5c string[]
Certificate chain of the key, in leaf to root order. Each item is a base64 encoded DER certificate. The service adds this field only when a certificate chain is linked to the key.
property name* any
Public key in JSON Web Key (JWK) format. The service adds the x5c field when a certificate chain is linked to the key.
dids string[]required
DIDs that come from this key. The list holds the did:key DID and the did:web DID. The service adds the EBSI DID only for the default key.
]
]

Example (from schema)

{
  "keyManagementServices": [
    {
      "id": 1,
      "name": "igrantioVault",
      "keys": [
        {
          "isDefault": true,
          "jwk": {
            "kty": "EC",
            "crv": "P-256",
            "x": "<base64url-x-coordinate>",
            "y": "<base64url-y-coordinate>",
            "kid": "3f2a91c47b8d4e6fa0c5d7e18b924f30",
            "alg": "ES256",
            "x5c": [
              "string"
            ]
          },
          "dids": [
            "did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...",
            "did:web:demo-api.igrant.io:organisation:5f9a1b2c3d4e5f60718293a4"
          ]
        }
      ]
    }
  ]
}

400

The organisation is not valid, or the organisation has no key management record.

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"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

Loading...