Compact Semantic Credential Configuration

Used to differentiate between different Compact/Compact Semantic credential configurations on your tenant. Thus, its value must:

• Be unique across all Compact/Semantic compact credential configurations on your tenant.
• Not be VerifiableCredential. type: string

This is where you specify how to map claims (user attributes) into issued credentials. Each field in the object corresponds to a claim in the issued credential, and contains one or more from the following attributes:

• mapFrom: References the path in the user object where the claim is available.
  • When using a URL as a claims namespace identifier, use bracket notation to access the claim value (e.g. mapFrom: "claims['https://example.com/claim-name']").
  • mapFrom is optional when defaultValue is provided, as the latter will be used for all issued credentials. This is referred to as a static claim.
• defaultValue: Indicates what value is used if required is set to false (field is optional) and no value is provided by the claims source. When defaultValue is provided, mapFrom is optional.
• required: Indicates whether the claim is required (default: false). When a required claim cannot be retrieved and no defaultValue is available, credential issuance will fail.

Example claims object inside the user object

{
  "claims": {
    "given_name": "Jamie",
    "family_name": "Doe",
    "address": {
      "formatted": "116-118 Quay Street, Auckland CBD, Auckland 1010"
    }
  },
  "authenticationProvider": {
    "subjectId": "6d3aab7d-73af-5f61-b47c-109ef6f7558c",
    "url": "https://accounts.google.com"
  }
}

When set to true (default), the created credential can later be revoked. When set to false, the credential cannot be revoked.

References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.

Used to differentiate between different Compact/Compact Semantic credential configurations on your tenant. Thus, its value must:

• Be unique across all Compact/Semantic compact credential configurations on your tenant.
• Not be VerifiableCredential. type: string

This is where you specify how to map claims (user attributes) into issued credentials. Each field in the object corresponds to a claim in the issued credential, and contains one or more from the following attributes:

• mapFrom: References the path in the user object where the claim is available.
  • When using a URL as a claims namespace identifier, use bracket notation to access the claim value (e.g. mapFrom: "claims['https://example.com/claim-name']").
  • mapFrom is optional when defaultValue is provided, as the latter will be used for all issued credentials. This is referred to as a static claim.
• defaultValue: Indicates what value is used if required is set to false (field is optional) and no value is provided by the claims source. When defaultValue is provided, mapFrom is optional.
• required: Indicates whether the claim is required (default: false). When a required claim cannot be retrieved and no defaultValue is available, credential issuance will fail.

Example claims object inside the user object

{
  "claims": {
    "given_name": "Jamie",
    "family_name": "Doe",
    "address": {
      "formatted": "116-118 Quay Street, Auckland CBD, Auckland 1010"
    }
  },
  "authenticationProvider": {
    "subjectId": "6d3aab7d-73af-5f61-b47c-109ef6f7558c",
    "url": "https://accounts.google.com"
  }
}

When set to true (default), the created credential can later be revoked. When set to false, the credential cannot be revoked.

References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.