Create a CWT credential configuration

POST/v2/credentials/compact/configurations

Creates a new CWT credential configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.

Roles

adminissuer

Analytics Events

CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_STARTCREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_SUCCESSCREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The credential configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/configurations" \  -H "Content-Type: application/json" \  -d '{    "claimMappings": {      "firstName": {        "mapFrom": "claims.given_name",        "required": true      },      "address": {        "mapFrom": "claims.address.formatted"      },      "picture": {        "mapFrom": "claims.picture",        "defaultValue": "http://example.edu/img/placeholder.png"      },      "badge": {        "defaultValue": "http://example.edu/img/badge.png"      },      "providerSubjectId": {        "mapFrom": "authenticationProvider.subjectId"      }    }  }'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "type": "CourseCredential",  "claimMappings": {    "firstName": {      "mapFrom": "claims.given_name",      "required": true    },    "address": {      "mapFrom": "claims.address.formatted"    },    "picture": {      "mapFrom": "claims.picture",      "defaultValue": "http://example.edu/img/placeholder.png"    },    "badge": {      "defaultValue": "http://example.edu/img/badge.png"    },    "providerSubjectId": {      "mapFrom": "authenticationProvider.subjectId"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 1,    "months": 12,    "weeks": 52,    "days": 365,    "hours": 24,    "minutes": 1440,    "seconds": 3600  }}

Create a CWT credential configuration

POST/v2/credentials/compact/configurations

Roles

adminissuer

Analytics Events

CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_STARTCREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_SUCCESSCREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The credential configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

type*string

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

Be unique across all CWT/Semantic CWT credential configurations on your tenant.
Not be VerifiableCredential.

Length1 <= length <= 1024

claimMappings*

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"  }}

revocable?boolean

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

Defaulttrue

claimSourceId?string

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

Formatuuid

expiresIn?

Used to determine when will issued credentials expire. Can include any combination of years, months, weeks, days, hours, minutes and seconds.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/configurations" \  -H "Content-Type: application/json" \  -d '{    "claimMappings": {      "firstName": {        "mapFrom": "claims.given_name",        "required": true      },      "address": {        "mapFrom": "claims.address.formatted"      },      "picture": {        "mapFrom": "claims.picture",        "defaultValue": "http://example.edu/img/placeholder.png"      },      "badge": {        "defaultValue": "http://example.edu/img/badge.png"      },      "providerSubjectId": {        "mapFrom": "authenticationProvider.subjectId"      }    }  }'

{  "id": "983c0a86-204f-4431-9371-f5a22e506599",  "type": "CourseCredential",  "claimMappings": {    "firstName": {      "mapFrom": "claims.given_name",      "required": true    },    "address": {      "mapFrom": "claims.address.formatted"    },    "picture": {      "mapFrom": "claims.picture",      "defaultValue": "http://example.edu/img/placeholder.png"    },    "badge": {      "defaultValue": "http://example.edu/img/badge.png"    },    "providerSubjectId": {      "mapFrom": "authenticationProvider.subjectId"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 1,    "months": 12,    "weeks": 52,    "days": 365,    "hours": 24,    "minutes": 1440,    "seconds": 3600  }}

How would you rate this page?

{ "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" }}

Create a CWT credential configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

Create a CWT credential configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`