Configure a claims source

POST/v1/claim-sources

Configures a new claims source for your tenant. When issuing a new credential, MATTR VII will make either a GET or a POST request to the claims source using the configured request parameters and fetch available data. This fetched data can then be included in the issued credential.

Analytic event

CLAIM_SOURCE_CREATE_START
CLAIM_SOURCE_CREATE_SUCCESS
CLAIM_SOURCE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The claim source payload

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Claims source name.

url*string

Claims source URL (and any redirects it may include):

Must be a valid URL.
Must use the HTTPS protocol.
Must not be an IP address.
Must not include query parameters.
Unicode will be converted to ASCII.

requestMethod?string

Indicates the request method MATTR VII will use when retrieving data from this claims source. Both the GET and POST method are supported. If no value is provided, GET is used by default. When using POST, all requestParameters must be included in the request body in JSON format.

Value in

"GET"
"POST"

requestParameters*||

Use this object to define how to map request parameters that are sent to your claims source using the mapFrom and defaultValue properties:

When only providing mapFrom, the request parameter will be mapped from the defined path. If mapping fails, no alternative value is used. You can map data from both the claims and credentialConfiguration objects.
When providing both mapFrom and defaultValue, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, the defaultValue is used instead.
When only providing defaultValue, its value is used to populate the request parameter, regardless of any available claims values.

authorization*|

Authentication method configuration to access the claims source.

Response Body

`application/json`

curl -X POST "https://example.com/v1/claim-sources" \  -H "Content-Type: application/json" \  -d '{    "name": "Claims source accepting a x-api-key header",    "url": "https://example.com/api/data",    "authorization": {      "type": "api-key",      "value": "6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"    },    "requestParameters": {      "account_type": {        "mapFrom": "claims.accountType",        "defaultValue": "account.student"      },      "account_id": {        "mapFrom": "claims.accountId"      }    }  }'

{  "name": "Claims source accepting a x-api-key header",  "url": "https://example.com/api/data",  "authorization": {    "type": "api-key",    "value": "****************************************61m1J"  },  "requestParameters": {    "account_type": {      "mapFrom": "claims.accountType",      "defaultValue": "account.student"    },    "account_id": {      "mapFrom": "claims.accountId"    }  }}

Configure a claims source

Roles

Analytic event

Authorization

Request Body

Response Body

201application/json

400application/json

Example Authorization with x-api-key header

Example Authorization with OAuth 2.0 client credentials

`application/json`

`application/json`