light-mode-image
Learn
MATTR VII PlatformUsers

Retrieve a user

Retrieve an existing user by providing its ID.

  • USER_RETRIEVE_START
  • USER_RETRIEVE_SUCCESS
  • USER_RETRIEVE_FAIL

Roles

adminissuer
GET/v1/users/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

User ID

Formatuuid

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v1/users/8241400f-de3b-42c5-ad7c-8a380039e796"
{
  "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"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?