Update a claims source
Updates an existing claim source by providing its claimSourceID.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>id*stringClaims source ID
uuidThe updated claims source payload
application/json- body
name*stringClaims source name.
url*stringClaims 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?stringIndicates 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.
"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 theclaimsandcredentialConfigurationobjects, as well as the credential correlation identifiers described below. - When providing both
mapFromanddefaultValue, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, thedefaultValueis used instead. - When only providing
defaultValue, its value is used to populate the request parameter, regardless of any available claims values.
The following top-level mapFrom roots are available to correlate the claims source request with the issuance operation:
credentialBundleId: Identifies the specific credential issued within an issuance session. A single session that issues more than one credential type produces a distinctcredentialBundleIdfor each.credentialReferenceId: A stable identifier for a holder's credential of a given type. It remains the same across re-issuance, so it can be used to correlate renewed copies of the same credential.sessionId: Identifies the issuance session. A session may span more than one credential request, so it is broader than a single request but narrower thancredentialReferenceId.claimSetId: Identifies the claim set the credential is being issued for. Map it withmapFrom: "claimSetId"to query your claim source for the data belonging to that claim set. Only populated when the credential request resolves to a claim set. Claim set identifiers are offered as an open beta preview feature, so their behavior may change in a way that breaks existing integrations before they become generally available.
authorization*|Authentication method configuration to access the claims source.
Claims source updated
application/json- response
Returns the claims source details, including a claimSourceId. You will use the this identifier to reference your claims source when creating your credential configuration.
id?stringClaims source unique identifier
uuidname*stringClaims source name.
url*stringClaims 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?stringIndicates 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.
"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 theclaimsandcredentialConfigurationobjects, as well as the credential correlation identifiers described below. - When providing both
mapFromanddefaultValue, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, thedefaultValueis used instead. - When only providing
defaultValue, its value is used to populate the request parameter, regardless of any available claims values.
The following top-level mapFrom roots are available to correlate the claims source request with the issuance operation:
credentialBundleId: Identifies the specific credential issued within an issuance session. A single session that issues more than one credential type produces a distinctcredentialBundleIdfor each.credentialReferenceId: A stable identifier for a holder's credential of a given type. It remains the same across re-issuance, so it can be used to correlate renewed copies of the same credential.sessionId: Identifies the issuance session. A session may span more than one credential request, so it is broader than a single request but narrower thancredentialReferenceId.claimSetId: Identifies the claim set the credential is being issued for. Map it withmapFrom: "claimSetId"to query your claim source for the data belonging to that claim set. Only populated when the credential request resolves to a claim set. Claim set identifiers are offered as an open beta preview feature, so their behavior may change in a way that breaks existing integrations before they become generally available.
authorization*|Authentication method configuration to access the claims source.
curl -X PUT 'https://example.vii.au01.mattr.global/v1/claim-sources/41458e5a-9092-40b7-9a26-d4eb43c5792f' \ -H 'Content-Type: application/json' \ -d '{ "name": "My claims from example.com", "url": "https://example.com", "requestParameters": { "property1": { "mapFrom": "claims.accountType" }, "property2": { "mapFrom": "claims.accountType" } }, "authorization": { "type": "api-key" }}'{ "id": "57fa09e2-82f3-4d3d-9eca-d0253e84a4e6", "name": "My claims from example.com", "url": "https://example.com", "requestMethod": "GET", "requestParameters": { "property1": { "mapFrom": "claims.accountType" }, "property2": { "mapFrom": "claims.accountType" } }, "authorization": { "type": "api-key", "value": "****************************************61m1J" }}How would you rate this page?