Skip to main content

Read secure vault

GET 
/v2/config/digital-wallet/openid/key-management

Reads the current secure vault configuration of the organisation. The response shows each vault and tells you if it is enabled. The service does not send a field that has no value.

The response holds the stored vault credentials in clear text, which includes hashicorpVault.vaultPassword and qtsp.clientSecret. Protect the response as you protect the credentials. The QTSP user PIN is the only secret that the service never sends back.

The response status code of this operation is 201, not 200.

Request​

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses​

Secure vault configuration read successfully.

Response Headers
    Schema
      hashicorpVault objectrequired

      Hashicorp Vault configuration.

      enabled booleanrequired

      Shows true when the Hashicorp vault is enabled.

      vaultUsername string

      User name for Hashicorp Vault authentication.

      vaultPassword string

      Password for Hashicorp Vault authentication.

      vaultAddress string

      Base address of the Hashicorp Vault server.

      vaultNamespace string

      Namespace in Hashicorp Vault.

      igrantioVault objectrequired

      iGrant.io managed vault configuration.

      enabled booleanrequired

      Shows true when the iGrant.io vault is enabled.

      qtsp objectrequired

      Qualified Trust Service Provider (QTSP) configuration.

      enabled booleanrequired

      Shows true when the QTSP vault is enabled.

      cscUrl string

      Base URL of the CSC service.

      clientId string

      Client ID for QTSP authentication.

      clientSecret string

      Client secret for QTSP authentication.

      userID string

      User ID registered with the QTSP.

      credentialId string

      ID of the QTSP signing credential that is in use. Set this value with the configure QTSP credential operation.

      cscApiVersion string

      Possible values: [v1, v2]

      CSC API version in use. v1 is CSC 1.0.4.0 and v2 is CSC 2.2.0.0.

      dbBackedVault objectrequired

      Database backed vault configuration.

      enabled booleanrequired

      Shows true when the database backed vault is enabled.

    Loading...
    Last updated on