Conformity Credential

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The ConformityCredential component allows users to request and manage conformity credentials. It displays a list of available credential requests as buttons and a table of stored credentials. The component handles the process of requesting credentials from a specified API, storing them locally, and displaying them in a table format.

Example

{
  "name": "ConformityCredential",
  "type": "Void",
  "props": {
    "credentialRequestConfigs": [
      {
        "url": "http://example.com/deforestation-free-assessment",
        "params": {},
        "options": {
          "headers": [],
          "method": "POST"
        },
        "credentialName": "Deforestation Free Assessment",
        "credentialPath": "/body/credential",
        "appOnly": "Farm"
      },
      {
        "url": "http://example.com/ce",
        "params": {},
        "options": {
          "headers": [],
          "method": "GET"
        },
        "credentialName": "CE Marking",
        "credentialPath": "",
        "appOnly": "Farm"
      },
      {
        "url": "http://example.com/conformity",
        "params": {},
        "options": {
          "headers": [],
          "method": "POST"
        },
        "credentialName": "Conformity",
        "appOnly": "Feedlot"
      }
    ],
    "storedCredentialsConfig": {
      "url": "http://localhost:3334/v1/documents",
      "params": {
        "resultPath": "/uri",
        "bucket": "verifiable-credentials"
      },
      "options": {
        "method": "POST",
        "headers": {
          "Content-Type": "application/json"
        }
      }
    }
  }
}

Definitions

Property	Required	Description	Type
name	Yes	The name of the component (should be "ConformityCredential")	String
type	Yes	The type of the component (should be "Void")	ComponentType
props	Yes	The properties for the ConformityCredential	Props

Props

Property	Required	Description	Type
credentialRequestConfigs	Yes	An array of credential request configurations	CredentialRequestConfig[]
storedCredentialsConfig	Yes	Configuration for storing credentials	Storage

CredentialRequestConfig

Property	Required	Description	Type
url	Yes	The URL for the credential request	String
params	No	Parameters for the request	Object
options	Yes	Request options	RequestOptions
credentialName	Yes	The name of the credential	String
credentialPath	No	The path to extract the credential from the response	String
appOnly	Yes	The application context for the credential	String

RequestOptions

Property	Required	Description	Type
headers	No	Headers for the request	Array
method	Yes	HTTP method for the request	String