MATTR VII Platform API

🪪 CREDENTIAL ISSUANCE

Establishing Trust

OID4VCI

Create a User POST Retrieve all users GET Retrieve a user GET Update a User PUT Delete a user DELETE Search users POST Retrieve all user credentials data GET

Direct Issuance

mDocs Management

CWT Credentials Management

JSON Credentials Management

📱 CREDENTIAL HOLDING

✅ CREDENTIAL VERIFICATION

Establishing Trust

mDocs Verification

CWT Credentials Verification

JSON Credentials Verification

🌐 TRUST NETWORKS

Establishing Trust

Ecosystem

Participants

Policies

VICAL

RICAL

⚙️ PLATFORM MANAGEMENT

General

Configuration

MATTR VII Management API

Overview

API ReferenceUsers

Update a User

PUT/v1/users/{id}

Updates an existing user by providing its ID.

USER_UPDATE_START
USER_UPDATE_SUCCESS
USER_UPDATE_FAIL

Roles

adminissuermanaged-issuer

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Update a User

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/users/8241400f-de3b-42c5-ad7c-8a380039e796" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",  "claims": {    "externalUserId": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba"  },  "authenticationProvider": {    "providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",    "url": "https://example-university.au.auth0.com",    "subjectId": "example-university-oauth2|123456789"  }}

How would you rate this page?

Retrieve a user GET

Retrieve an existing user by providing its ID. * USER_RETRIEVE_START * USER_RETRIEVE_SUCCESS * USER_RETRIEVE_FAIL

Delete a user DELETE

Deletes a user and removes all data related to them by providing the user ID. <Callout type="warning"> Deleting a user is irreversible. All of the user's data is removed, and any credential previously issued to them is no longer valid. </Callout>

API ReferenceUsers

Update a User

PUT/v1/users/{id}

Updates an existing user by providing its ID.

USER_UPDATE_START
USER_UPDATE_SUCCESS
USER_UPDATE_FAIL

Roles

adminissuermanaged-issuer

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

User ID

Formatuuid

Request Body

application/json

Update a User

TypeScript Definitions

Use the request body type in TypeScript.

claims?

User claims to be persisted. No claims are persisted by default. Consider PII implications before persisting any claims.

authenticationProvider?

Authentication Provider information for the user. This enables linking the user to an external identity provider. If implemented insecurely, this process can be exploited by malicious actors to gain unauthorized access to legitimate user accounts.

To mitigate this risk, require authentication for both accounts involved in the link, whether the link is created manually or automatically. Always prompt the user to enter credentials to verify ownership before establishing the link.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/users/8241400f-de3b-42c5-ad7c-8a380039e796" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",  "claims": {    "externalUserId": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba"  },  "authenticationProvider": {    "providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",    "url": "https://example-university.au.auth0.com",    "subjectId": "example-university-oauth2|123456789"  }}

How would you rate this page?

Retrieve a user GET

Retrieve an existing user by providing its ID. * USER_RETRIEVE_START * USER_RETRIEVE_SUCCESS * USER_RETRIEVE_FAIL

Delete a user DELETE

Update a User

Roles

200application/json

400application/json

404application/json

Update a User

Roles

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`