Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 9

A Credential Definition is a structured list of attributes defined in the Credential Schema. Refer to theNew Dashboard Credential Schemas Page for more information about credential schemas.

...

Service-attested means that a credential will be created, signed, and issued to a client by the service.

After attributes have been defined in the credential schema, you need to create a credential definition.

Features

 

Description

Screenshots

To use the credential in the interaction

Create Credential Definition

To create the Credential Definition, click the “Schemas” button on the main menu.

Choose the schema

Click the “My schemas” tab to use a schema intended for this service only, or click on the “Public schemas” tab to use a schema made by /for other services.

Create the credential definition

Click the “Create” button next to the selected schema’s name in the schema list.

Trust level

Check the “Self-attestedoption to allow the client of the mobile app to fill in the information and send it to the servicecheckbox if the data in this credential will be provided by the client personally (without previous verification by any service).

Click the “Service-attestedoption for client credentials to be created, signed, checkbox if this credential should be signed and issued by the service.

 

 One-off

Select the one-off checkbox to have the client of a mobile application fill in the credential attributes each time an interaction that requires requiring this credential is executed. This

Note that this option is only accessible for self-attested credentials.

Third-party (external) verification

An additional external (third-party) verification hook can be optionally specified and called during the interaction execution for the service-attested credentials. For example:anchoring of the credential hash can be additionally verified in third-party blockchain.

To set an external verification hook, click on the field with the corresponding name. The "Edit webhook" pop-up window will appear. In the "URL Template" field, enter the URL for the webhook request, then choose the key and authentication (auth) type for the webhook from the drop-down lists.

Please note that the key type “SHA secret“ can be used only in auth type “Bearer Token“.

For more information about webhook and keys, see the https://zaka.atlassian.net/wiki/spaces/PSM/pages/2044985359 and visit Integration Webhooks API Overview.

See more information about the "Use external verification" check box in the “External verification hook” section of the https://zaka.atlassian.net/wiki/spaces/PSM/pages/2032271394.

Image RemovedImage Removed

 

Set the authorized keys and IP prefixes for incoming credential issuing webhook requests from the third-party systems.

To configure the list of authorized IP prefixes and keys for web-hook requests to this service from third-party systems, click the "Add" button in the "Web hook accepted keys" next to “Configuration of an incoming credential issuing webhook“ area.

The Then, on the "Edit external web hook access" pop-up window will appear. , click “Allowed IP Prifix.“ Add allowed IP prefixes (e.g. 192.168) by clicking the "Add IP prefix" button. Choose , and choose the key type and authentication type from the drop-down lists. Note that the key type “SHA secret“ "SHA secret" can be used only in auth type “Bearer Token“"Bearer Token".

For more information about webhook and keys, see the https://zaka.atlassian.net/wiki/spaces/PSM/pages/2044985359 and visit Integration Webhooks API Overview.

Change attribute metadata

The "Schema details"   section contains the details that have previously been saved. 

In this section, the attribute You can change the attribute metadata and the order of the schema attributes may be changedschema attributes.

 

Change attribute metadata The attribute ”Credential Issue Date” cannot be changed.

The options for changing metadata include:

  1. Modify or add a description to the attribute.

  2. Check the “Multi line” checkbox to enable “Text” attribute editing with multi-line support (new line).

  3. QR codes can be used as a data source. Check the relevant checkbox.

Note that the attribute ”Credential Issue Date” cannot be changed.

Change attribute metadata (continue)

To make changes on the credential definition’s metadata, click the "Edit" icon in the "My Credential Definitions" tab. The "Update Credential Definition Meta Data" page will appear. Make on desired attribute and make all the necessary changes.

To make changes on the created credential definition’s metadata, click on desired credential ID, and make all the necessary changes.

If you add all details, click “Create“ or “Done“ to save your changes.

Change attribute metadata (Updating “Enum“ type attribute)

If Data type “Enumerated type the data type used for for the current credential attribute is “Enumerated (E-num)” was used for the current attribute, values can be edited or deleted.On the “Edit attribute” , you can edit or delete it’s values.

To do so, click on the attribute you want to edit, and, on the pop-up window , click the “Enumerated type (E-num)” data type attribute which value needs to be updated. Make all make all the necessary changes and click “Change.“

If you add all details, click “Create” or “Done“ to save your changes.

Change the order of the attributes

To rearrange the order of your schema attributes, move hover the mouse cursor to over the attribute you want to move, click, and drag the attribute to the desired location without releasing it. Release the mouse button to set the new order.

Save Credential Definition

If all details are correct, click the “Create” button“Create” for create a credential definition or “Done“ for save the changes you’ve made to this credential definition.

 

After the “Create” button has been clicked, this credential definition you have created the credential definition, please note that it cannot be deleted.

 

Find Credential Definition

This credential definition can be found You can find all your credential definitions in the section "My Credential Definitions" of the main menu menu’s "Schemas" page.

Adjust attributes metadata after Credential Definition has been created

After saving the credential definition, the credential definition's metadata and external verification hook can be adjusted.

Click the “Schemas” tab of the main menu, select the “My credential Definitions“ tab and choose the credential definition you want to change by clicking on the “Edit“ iconit’s ID. Make all necessary changes and click “Save.“

Deprecate Credential Definition

If for any reason, you don't want the particular credential definition to be visible in the list of credential definitions, you may deprecate it.

Click on the "Edit" icon next to the credential definition’s name and tick the "Deprecate" checkbox in the "Update Credential Definition Meta Data" on the next page.

To see ALL credential definitions in those lists again, check the "Show deprecated" checkbox on the "Schemas" page.
If a deprecated credential definition is already used for issuing credentials by your service or any other service, it will keep functioning as it previously did.

However, if you try to edit such an interaction, the system automatically removes the credentials based on a deprecated credential definition from the interaction's settings. To avoid it, tick the checkbox "Show deprecated."

...