CWT Credentials

Create a CWT Credential configuration

POST/v2/credentials/compact/configurations

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": {      "property1": {},      "property2": {}    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Retrieve all CWT Credential configurations

GET/v2/credentials/compact/configurations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

type?string

The optional credential type to filter on

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/configurations"

{  "nextCursor": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "claimMappings": {        "property1": {          "mapFrom": "string",          "required": true,          "defaultValue": "string"        },        "property2": {          "mapFrom": "string",          "required": true,          "defaultValue": "string"        }      },      "revocable": true,      "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",      "expiresIn": {        "years": 0,        "months": 0,        "weeks": 0,        "days": 0,        "hours": 0,        "minutes": 0,        "seconds": 0      }    }  ]}

Retrieve a CWT Credential configuration

GET/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Update a CWT Credential configuration

PUT/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Request Body

application/json

Update a CWT credential configuration

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "claimMappings": {      "property1": {},      "property2": {}    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Delete a CWT Credential configuration

DELETE/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Create a CWT Credential configuration

POST/v2/credentials/compact/configurations

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": {      "property1": {},      "property2": {}    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Retrieve all CWT Credential configurations

GET/v2/credentials/compact/configurations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

type?string

The optional credential type to filter on

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/configurations"

{  "nextCursor": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "claimMappings": {        "property1": {          "mapFrom": "string",          "required": true,          "defaultValue": "string"        },        "property2": {          "mapFrom": "string",          "required": true,          "defaultValue": "string"        }      },      "revocable": true,      "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",      "expiresIn": {        "years": 0,        "months": 0,        "weeks": 0,        "days": 0,        "hours": 0,        "minutes": 0,        "seconds": 0      }    }  ]}

Retrieve a CWT Credential configuration

GET/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Update a CWT Credential configuration

PUT/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Request Body

application/json

Update a CWT credential configuration

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*

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 PUT "https://example.com/v2/credentials/compact/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "claimMappings": {      "property1": {},      "property2": {}    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "string",  "claimMappings": {    "property1": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    },    "property2": {      "mapFrom": "string",      "required": true,      "defaultValue": "string"    }  },  "revocable": true,  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  }}

Delete a CWT Credential configuration

DELETE/v2/credentials/compact/configurations/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the CWT credential configuration.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/compact/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

On this page

CWT Credentials

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`