Update credential definition
Changes a credential definition. The new values apply to the next issue calls; the issuance histories that started before keep the version of the definition that governs them. Each update makes a new version (definitionVersion of the answer).
credentialConfigurationsis the complete new list: an entry with theidand thecredentialFormatof a stored configuration changes that configuration (it keeps itscredentialConfigurationId); an entry withoutidis a new configuration; a stored configuration that is not in the list is removed from the Credential Issuer Metadata. You can send a configuration of Read credential definition as it is: the issuer ignores its read-only membersigningKeyCheck.- A top-level member that you leave out keeps its stored value, except
externalOpenidProviderId(the definition loses its provider). See each field. - The update ignores
display.logo.urianddisplay.backgroundImage.uri: change the images with Update credential definition logo image and Update credential definition cover image. - The signing key is in each configuration (
cryptographicKeyFormat,cryptographicKeyIdentifier), with the checks of the create call; the issuer refuses a key at the top level. A configuration without a key gets the stored key of the definition. After the update, the key of the definition in the answer is the key of the first configuration. - A configuration whose type is a PID lists every mandatory attribute of PID Rulebook v1.7 and marks it mandatory, as on create.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
credential-definitions:update
Path parameters
definitionId stringrequiredThe id of the credential definition (
credentialDefinitionId), from List credential definitions.
Body
The new values of the credential definition. credentialConfigurations is required. The issuer refuses a member that it does not know (HTTP 400).
labelstringYour name for the credential definition, 3 to 100 characters. Left out: the stored label stays. The labels of the platform (
Payment User Credential,Payment Card Credential,Payment Account Credential,PID Issuance,Photo ID Issuance) are refused.3 to 100 characters.
Example:
"Issue Portable Document A1"credentialConfigurations object[]requiredThe complete new list of the credential configurations. An entry with the
idand thecredentialFormatof a stored configuration changes it: it keeps its id and itscredentialConfigurationId. An entry withoutid, or with anothercredentialFormat, is a new configuration. A stored configuration that is not in the list is removed. An entry withidthat leaves outexpirationInDaysandexpirationInSecondskeeps its validity. A configuration member at the top level is checked for its type and not used.At least 1 item.
requiresTrusted Wallet Provider booleantrue: the wallet must send a valid wallet unit attestation, and its signer and the signer of each key attestation of a wallet provider must come fromacceptedWalletProviders: see Create credential definition.false: no trust check runs. Issuance histories that already started keep the value of their version. Left out: the stored value stays.acceptedWallet Providers string (uuid)[]The trust sources that the wallet provider must come from (their
id, from List trust sources), each used forwallet_provider. Required whenrequiresTrustedWalletProvideristrue(trust.accepted_list_required). The value stays when the switch isfalse. Left out: the stored list stays.requiresInteractive Authorisation booleantrue: the issuance uses the Interactive Authorization Endpoint (credential issuer identifierv1.0-iar). Left out: the stored value stays.externalOpenid Provider Id string | nullAn external OpenID provider of the organisation that authenticates the holder in the Authorization Code Flow. Another value gives HTTP 400. Left out, empty or
null: the credential definition has no provider after the update.allowsWallet Initiated Issuance booleantrue: a wallet can start an issuance without a credential offer. Left out: the stored value stays.allowsCredential Offer Reuse booleantrue: one credential offer can start one issuance for each wallet, until itsissuer_stateexpires. Left out: the stored value stays.displayobjectThe display of the credential definition. It replaces the stored display, but the issuer keeps the stored
logo.uriandbackgroundImage.uri: change the images with the logo and cover image calls of the credential definition.
Response
The credential definition after the update, with its new definitionVersion.
credentialDefinition objectA credential definition. The top-level members are the settings of the whole definition (label, signing key, trust in wallets, issuance options);
credentialConfigurationshas the credential configurations that the issuer publishes in the Credential Issuer Metadata. Some top-level members (the format, the type, the claims, the validity, the holder binding and the proof types) are read-only copies of the first credential configuration: the configurations govern the issuance.