package services.verifiablecredentials.templates.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Create (CreateCredentialTemplateRequest, CreateCredentialTemplateResponse)

  templates.proto:267

  Create a credential template in the current ecosystem

  message CreateCredentialTemplateRequest

  templates.proto:80

  Request to create a new template

  • string name = 1

    Name of new template. Must be a unique identifier within its ecosystem.

  • map<string, TemplateField> fields = 2

    Fields which compose the template

  • bool allow_additional_fields = 3

    Whether credentials may be issued against this template which have fields not specified in `fields`

  • string title = 4

    Human-readable name of template

  • string description = 5

    Human-readable description of template

  • map<string, FieldOrdering> field_ordering = 6

    Optional map describing how to order and categorize the fields within the template. The key of this map is the field `name`. If not provided, this will be auto-generated.

  • optional AppleWalletOptions apple_wallet_options = 7

    Options for rendering the template in Apple Wallet

  message CreateCredentialTemplateResponse

  templates.proto:106

  Response to `CreateCredentialTemplateRequest`

  • optional TemplateData data = 1

    Created template

• rpc CreateVerificationTemplate (CreateVerificationTemplateRequest, CreateVerificationTemplateResponse)

  templates.proto:315

  Create/update verification templates

  message CreateVerificationTemplateRequest

  templates.proto:365

  • string name = 1

    Name of new template. Must be a unique identifier within its ecosystem.

  • map<string, VerificationTemplateField> fields = 2

    Fields which will be required in the verification proof template

    TODO - Add support for predicate types - currently only equality.

  • string credential_template_id = 3

    Source credential template, used for verifying that the specified `fields` are present in the credential template

  • string title = 4

    Human-readable name of template

  • string description = 5

    Human-readable description of template

  message CreateVerificationTemplateResponse

  templates.proto:382

  • optional VerificationTemplateData data = 1

• rpc Delete (DeleteCredentialTemplateRequest, DeleteCredentialTemplateResponse)

  templates.proto:307

  Delete a credential template from the current ecosystem by ID

  message DeleteCredentialTemplateRequest

  templates.proto:71

  Request to delete a template by ID

  • string id = 1

    ID of template to delete

  message DeleteCredentialTemplateResponse

  templates.proto:77

  Response to `DeleteCredentialTemplateRequest`

  (message has no fields)

• rpc DeleteVerificationTemplate (DeleteVerificationTemplateRequest, DeleteVerificationTemplateResponse)

  templates.proto:343

  message DeleteVerificationTemplateRequest

  templates.proto:399

  • string verification_template_id = 1

  message DeleteVerificationTemplateResponse

  templates.proto:402

  This space intentionally left blank

  (message has no fields)

• rpc Get (GetCredentialTemplateRequest, GetCredentialTemplateResponse)

  templates.proto:275

  Fetch a credential template by ID

  message GetCredentialTemplateRequest

  templates.proto:15

  Request to fetch a template by ID

  • string id = 1

    ID of template to fetch

  message GetCredentialTemplateResponse

  templates.proto:21

  Response to `GetCredentialTemplateRequest`

  • optional TemplateData template = 1

    Template fetched by ID

• rpc GetVerificationTemplate (GetVerificationTemplateRequest, GetVerificationTemplateResponse)

  templates.proto:329

  message GetVerificationTemplateRequest

  templates.proto:353

  Request to fetch a template by ID

  • string id = 1

    ID of template to fetch

  message GetVerificationTemplateResponse

  templates.proto:359

  Response to `GetCredentialTemplateRequest`

  • optional VerificationTemplateData template = 1

    Template fetched by ID

• rpc List (ListCredentialTemplatesRequest, ListCredentialTemplatesResponse)

  templates.proto:291

  Search credential templates using SQL, returning strongly-typed template data

  message ListCredentialTemplatesRequest

  templates.proto:49

  Request to list templates using a SQL query

  • string query = 1

    SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`

  • string continuation_token = 2

    Token provided by previous `ListCredentialTemplatesResponse` if more data is available for query

  message ListCredentialTemplatesResponse

  templates.proto:59

  Response to `ListCredentialTemplatesRequest`

  • repeated TemplateData templates = 1

    Templates found by query

  • bool has_more_results = 2

    Whether more results are available for this query via `continuation_token`

  • string continuation_token = 3

    Token to fetch next set of results via `ListCredentialTemplatesRequest`

• rpc ListVerificationTemplates (ListVerificationTemplatesRequest, ListVerificationTemplatesResponse)

  templates.proto:322

  message ListVerificationTemplatesRequest

  templates.proto:436

  Request to list templates using a SQL query

  • string query = 1

    SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`

  • string continuation_token = 2

    Token provided by previous `ListCredentialTemplatesResponse` if more data is available for query

  message ListVerificationTemplatesResponse

  templates.proto:445

  • repeated VerificationTemplateData templates = 1

    Templates found by query

  • bool has_more_results = 2

    Whether more results are available for this query via `continuation_token`

  • string continuation_token = 3

    Token to fetch next set of results via `ListVerificationTemplatesRequest`

• rpc Search (SearchCredentialTemplatesRequest, SearchCredentialTemplatesResponse)

  templates.proto:299

  Search credential templates using SQL, returning raw JSON data

  message SearchCredentialTemplatesRequest

  templates.proto:27

  Request to search templates using a SQL query

  • string query = 1

    SQL query to execute. Example: `SELECT * FROM c WHERE c.name = 'Diploma'`

  • string continuation_token = 2

    Token provided by previous `SearchCredentialTemplatesResponse` if more data is available for query

  message SearchCredentialTemplatesResponse

  templates.proto:37

  Response to `SearchCredentialTemplatesRequest`

  • string items_json = 1

    Raw JSON data returned from query

  • bool has_more_results = 2

    Whether more results are available for this query via `continuation_token`

  • string continuation_token = 4

    Token to fetch next set of results via `SearchCredentialTemplatesRequest`

• rpc Update (UpdateCredentialTemplateRequest, UpdateCredentialTemplateResponse)

  templates.proto:283

  Update metadata of a template

  message UpdateCredentialTemplateRequest

  templates.proto:112

  Request to update display information for a template

  • string id = 1

    ID of Template to update

  • optional string title = 2

    New human-readable title of Template

  • optional string description = 3

    New human-readable description of Template

  • map<string, TemplateFieldPatch> fields = 4

    Fields to update within the Template

  • map<string, FieldOrdering> field_ordering = 5

    New field ordering options. See documentation for template creation for usage information.

  • optional AppleWalletOptions apple_wallet_options = 6

    New Apple Wallet configuration

  message UpdateCredentialTemplateResponse

  templates.proto:128

  Response to `UpdateCredentialTemplateRequest`

  • optional TemplateData updated_template = 1

    The Template after the update has been applied

• rpc UpdateVerificationTemplate (UpdateVerificationTemplateRequest, UpdateVerificationTemplateResponse)

  templates.proto:336

  message UpdateVerificationTemplateRequest

  templates.proto:386

  • string id = 1

    ID of Template to update

  • optional string title = 2

    New human-readable title of Template

  • optional string description = 3

    New human-readable description of Template

  • map<string, VerificationTemplateFieldPatch> fields = 4

    Fields to update within the Template

  message UpdateVerificationTemplateResponse

  templates.proto:396

  • optional VerificationTemplateData template = 1

Configuration options for Apple Wallet when

Used in: CreateCredentialTemplateRequest, TemplateData, UpdateCredentialTemplateRequest

• string background_color = 1

  Background color, in hex format, of credential when stored in an Apple Wallet.

• string foreground_color = 2

  Foreground color, in hex format, of credential when stored in an Apple Wallet.

• string label_color = 3

  Label color, in hex format, of credential when stored in an Apple Wallet.

• string primary_field = 4

  The ID of the template field which should be used as the primary field of a credential.

• repeated string secondary_fields = 5

  The secondary fields of the credential. This is a mapping between the order of a secondary field (0 or 1) and the field name.

• repeated string auxiliary_fields = 6

  The auxiliary fields of the credential. This is a mapping between the order of an auxiliary field (0 or 1) and the field name.

Ordering information for a template field

Used in: CreateCredentialTemplateRequest, TemplateData, UpdateCredentialTemplateRequest

• int32 order = 1

  The order of the field; must be unique within the Template. Fields are sorted by order ascending when displaying a credential. Field orders must be contiguous from `0` to the number of fields minus 1.

• string section = 2

  The human-readable name of the section this field appears in; used to group together fields when displaying a credential. Sections must be contiguous with respect to `order`.

Valid types for credential fields

Used in: TemplateField

• STRING = 0

• NUMBER = 1

• BOOL = 2

• DATETIME = 4

• URI = 5

Credential Template

Used in: CreateCredentialTemplateResponse, GetCredentialTemplateResponse, ListCredentialTemplatesResponse, UpdateCredentialTemplateResponse

• string id = 1

  Template ID

• string name = 2

  Template name

• int32 version = 3

  Template version number

• map<string, TemplateField> fields = 4

  Fields defined for the template

• bool allow_additional_fields = 5

  Whether credentials issued against this template may contain fields not defined by template

• string schema_uri = 6

  URI pointing to template JSON schema document

• string ecosystem_id = 8

  ID of ecosystem in which template resides

• string type = 9

  Template type (`VerifiableCredential`)

• string created_by = 10

  ID of template creator

• string date_created = 11

  Date when template was created as ISO 8601 utc string

• string title = 12

  Human-readable template title

• string description = 13

  Human-readable template description

• map<string, FieldOrdering> field_ordering = 14

  Map describing how to order and categorize the fields within the template. The key of this map is the field `name`.

• optional AppleWalletOptions apple_wallet_options = 15

  Options for rendering the template in Apple Wallet

A field defined in a template

Used in: CreateCredentialTemplateRequest, TemplateData

• string title = 1

  Human-readable name of the field

• string description = 2

  Human-readable description of the field

• bool optional = 3

  Whether this field may be omitted when a credential is issued against the template

• FieldType type = 4

  The type of the field

• optional UriFieldData uri_data = 6

  How to deal with this URI field when rendering credential. Only use if `type` is `URI`.

A patch to apply to an existing template field

Used in: UpdateCredentialTemplateRequest

• optional string title = 1

  Human-readable name of the field

• optional string description = 2

  Human-readable description of the field

• optional UriFieldData uri_data = 3

  How to deal with this URI field when rendering credential. Only use if `type` is `URI`.

Data pertaining to a URI Field

Used in: TemplateField, TemplateFieldPatch

• string mime_type = 1

  Expected MIME Type of content pointed to by URI. Can be generic (eg, "image/") or specific ("image/png"). Defaults to "application/octet-stream".

• UriRenderMethod render_method = 2

  How to display the URI value when rendering a credential.

How to display a URI value when rendering a credential.

Used in: UriFieldData

• TEXT = 0

  Display URI as text

• LINK = 1

  Display URI as a clickable link

• INLINE_IMAGE = 2

  Display URI as an inline image. Only takes effect if the template field's MIME Type is an image type.

Used in: VerificationTemplateField, VerificationTemplateFieldPatch

• OPTIONAL = 0

• REQUIRED = 1

Verification Template

Used in: CreateVerificationTemplateResponse, GetVerificationTemplateResponse, ListVerificationTemplatesResponse, UpdateVerificationTemplateResponse

• string id = 1

  Template ID

• string name = 2

  Template name

• int32 version = 3

  Template version number

• map<string, VerificationTemplateField> fields = 4

  Fields defined for the template

• string credential_template_id = 5

  Source credential template, used for verifying that the specified `fields` are present in the credential template

• string ecosystem_id = 8

  ID of ecosystem in which template resides

• string type = 9

  Template type (`VerificationTemplate`)

• string created_by = 10

  ID of template creator

• string date_created = 11

  Date when template was created as ISO 8601 utc string

• string title = 12

  Human-readable template title

• string description = 13

  Human-readable template description

A field defined in a template

Used in: CreateVerificationTemplateRequest, VerificationTemplateData

• VerificationShareType field_share_type = 1

  Whether this field may be omitted on proof creation

• string usage_policy = 2

  User-facing explanation of what is done with this data

  TODO - Future work supporting proof conditionals/ranges/etc

A patch to apply to an existing template field

Used in: UpdateVerificationTemplateRequest

• VerificationShareType field_share_type = 1

  Human-readable name of the field

• string usage_policy = 2

  User-facing explanation of what is done with this data