Skip to main content

Update global configuration

PUT 
/v2/config/digital-wallet/openid/global-configuration/:globalConfigurationId

Updates the global configuration of the OID4VCI issuer.

The service replaces the full configuration. A field that you leave out goes back to its default value, so read the configuration first and send all fields that you want to keep. The service keeps the current logo and cover image of credentialBranding, and it ignores those two URLs in the request body.

Request​

Path Parameters

    globalConfigurationId stringrequired

    Unique identifier of the global configuration. Give globalConfigurationId for the issuer operations, holderGlobalConfigurationId for the holder operations, and verifierGlobalConfigurationId for the verifier operations. Do not give the id field of the record.

    Example: b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45

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

Body

required

New default issuance settings for the issuer. All fields are optional, but the service replaces the full configuration.

    credentialExpirationInDays number

    Default expiration period (in days) for all credentials issued under this configuration. Individual credential definitions can override this value. The service uses 30 when you give 0 or leave this field out.

    credentialBranding object

    Default display properties of the credential card in wallet UIs.

    name string

    Default display name for credentials in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.

    locale string

    BCP47 language tag for the display properties (e.g. en-GB).

    description string

    Default human-readable description for credentials displayed in wallet UIs.

    backgroundColor string

    Default hex color code for the credential card background (e.g. #FFFFFF).

    textColor string

    Default hex color code for text on the credential card (e.g. #000000).

    credentialRequestEncryptionRequired boolean

    When true, the wallet must encrypt the OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Request using the issuer's encryption key.

    authorizationRequestExpiry integer

    Time-to-live (in seconds) for the OID4VCI Authorization Request. After this period, the credential offer expires.

    credentialBindingMethods string[]

    Possible values: [did:key, jwk, cose_key]

    Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. When you leave this field out on an update, the service uses did:key, jwk, kid and x5c.

    credentialResponseInterval number

    Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint.

    notificationEndpointEnabled object

    Controls the OID4VCI Notification Endpoint per specification version. Set a version to true to publish the endpoint for wallets that use that version.

    draft_13 boolean

    When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 13.

    draft_15 boolean

    When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 15.

    draft_17 boolean

    When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 17.

    issuerMetadata object

    Signing settings for the OID4VCI Credential Issuer Metadata.

    signedMetadataEnabled boolean

    When true, the issuer publishes the Credential Issuer Metadata as a signed JWT.

    cryptographicKeyIdentifier stringnullable

    Key identifier of the key that signs the Credential Issuer Metadata. Send null when signedMetadataEnabled is false.

    cryptographicKeyFormat stringnullable

    Format of the signing key, for example kid, jwk or x509. Send null when signedMetadataEnabled is false. The service does not check this value.

Responses​

The issuer updated the global configuration.

Response Headers
    Schema
      globalConfiguration objectrequired

      The global configuration after the update.

      id stringrequired

      Record identifier of the global configuration. The service makes this value when it saves the record. It is not the same value as globalConfigurationId. Use globalConfigurationId in the path of the read, update and delete operations.

      globalConfigurationId stringrequired

      Unique identifier of the issuer global configuration. Give this value in the path of the read, update and delete operations.

      openIdOrganisationId stringrequired

      Identifier of the OpenID wallet deployment that holds this configuration.

      credentialExpirationInDays numberrequired

      Default expiration period (in days) for all credentials issued under this configuration. Individual credential definitions can override this value. The service uses 30 when the request gives 0 or leaves the field out.

      credentialBranding objectrequired

      Default display properties of the credential card in wallet UIs. The service always returns this object.

      name stringrequired

      Default display name for credentials in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.

      locale string

      BCP47 language tag for the display properties (e.g. en-GB). The service omits this field when it holds no value.

      description stringrequired

      Default human-readable description for credentials displayed in wallet UIs.

      backgroundColor stringrequired

      Default hex color code for the credential card background (e.g. #FFFFFF).

      textColor stringrequired

      Default hex color code for text on the credential card (e.g. #000000).

      logo objectrequired

      Logo that wallets show on the credential card. The service sets uri and ignores the value in the request body.

      uri stringrequired

      URL of the default logo displayed on credential cards in wallet UIs. The service sets this URL to the organisation logo, and it changes the URL to the configuration logo after an upload to the logo image operation.

      altText stringrequired

      Alt text for the logo image, used for accessibility.

      backgroundImage objectrequired

      Background image that wallets show on the credential card. The service sets uri and ignores the value in the request body.

      uri stringrequired

      URL of the default background image for credential cards.

      credentialRequestEncryptionRequired booleanrequired

      When true, the wallet must encrypt the OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Request using the issuer's encryption key.

      authorizationRequestExpiry integerrequired

      Time-to-live (in seconds) for the OID4VCI Authorization Request. After this period, the credential offer expires.

      credentialBindingMethods string[]nullablerequired

      Possible values: [did:key, jwk, cose_key]

      Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The value is null when the configuration holds no binding method.

      credentialResponseInterval numberrequired

      Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint.

      notificationEndpointEnabled object

      Shows for which OID4VCI specification versions the issuer publishes the Notification Endpoint. The service omits this field when the configuration holds no value.

      draft_13 boolean

      When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 13.

      draft_15 boolean

      When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 15.

      draft_17 boolean

      When true, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 17.

      issuerMetadata object

      Signing settings of the OID4VCI Credential Issuer Metadata. The service omits this field when the configuration holds no value.

      signedMetadataEnabled booleanrequired

      When true, the issuer publishes the Credential Issuer Metadata as a signed JWT.

      cryptographicKeyIdentifier stringnullable

      Key identifier of the key that signs the Credential Issuer Metadata. The service omits this field when signed metadata is off.

      cryptographicKeyFormat stringnullable

      Format of the signing key, for example kid, jwk or x509. The service does not check this value.

      createdAt numberrequired

      Unix timestamp (in seconds) when this configuration was created.

      updatedAt numberrequired

      Unix timestamp (in seconds) when this configuration was last modified.

    Loading...
    Last updated on