Retrieve all JSON credentials configurations

Returns a list of all JSON credential configurations on your tenant.

Analytics Events

CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_STARTCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESSCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL

Roles

adminissuer

GET/v2/credentials/web-semantic/configurations

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100

Range1 <= value <= 1000

cursor?string

Starting point for the list of entries.

type?string

The optional credential type to filter on

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/web-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential"

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/web-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential"

{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  "data": [
    {
      "id": "983c0a86-204f-4431-9371-f5a22e506599",
      "name": "Course credential",
      "description": "This credential shows that the person has attended a course.",
      "type": "CourseCredential",
      "additionalTypes": [
        "AlumniCredential",
        "EducationCredential"
      ],
      "contexts": [
        "https://optionalschema.example/"
      ],
      "issuer": {
        "name": "ABC University",
        "logoUrl": "https://example.edu/img/logo.png",
        "iconUrl": "https://example.edu/img/icon.png"
      },
      "proofType": "Ed25519Signature2018",
      "credentialBranding": {
        "backgroundColor": "#B00AA0",
        "watermarkImageUrl": "https://example.edu/img/watermark.png"
      },
      "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"
        }
      },
      "persist": false,
      "revocable": true,
      "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
      "expiresIn": {
        "years": 0,
        "months": 3,
        "weeks": 0,
        "days": 0,
        "hours": 0,
        "minutes": 0,
        "seconds": 0
      }
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}