light-mode-image
Learn
MATTR VII PlatformUsers

Create a User

Create a user.

  • USER_CREATE_START
  • USER_CREATE_SUCCESS
  • USER_CREATE_FAIL

Roles

adminissuer
POST/v1/users
AuthorizationBearer <token>

In: header

Create a User

claims?object

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

Empty Object

authenticationProvider?object

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

curl -X POST "https://example.vii.au01.mattr.global/v1/users" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",
  "claims": {
    "givenName": "Patrick John",
    "familyName": "Smith",
    "dob": "1990-06-01"
  },
  "authenticationProvider": {
    "providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",
    "url": "https://example-university.au.auth0.com",
    "subjectId": "example-university-oauth2|123456789"
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?