Get info about current user

GET 
/users/me

The info about the current user, can be used to show a user profile

Request

Query Parameters

include string
The attributes that will be returned together with the user info
Example: profile,clients

Header Parameters

X-Domain stringrequired

Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page

X-API-KEY stringrequired

An X-API-KEY key is a token that a client provides with a X-API-SECRET when making API calls, used instead of the JWT

X-API-SECRET stringrequired

An X-API-SECRET key is a token that a client provides with a X-API-KEY when making API calls, used instead of the JWT

Responses

200

Successful get a user info

application/vnd.api+json

Schema

Schema

data

object

type string

The type of the user

id string

The user id in a system

attributes

object

email string

The user email registered in a system

factory_password boolean

The flag that shows that a user was not logged in to the system and doesn't change default password that receive in the registration email

active boolean

last_login_date string

The date and time when the user the last time logged in the system

reachable boolean

created_at string

The date and time of the user creation

updated_at string

The date and time when the user was changed

archived_at string

The date and time when the user was archived

auth_provider string

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

Example (from schema)

{
  "data": {
    "type": "users",
    "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
    "attributes": {
      "email": "example@domain.com",
      "factory_password": true,
      "active": true,
      "last_login_date": "2016-01-01 12:00:00",
      "reachable": true,
      "created_at": "2016-01-01 12:00:00",
      "updated_at": "2016-01-01 12:00:00",
      "archived_at": "2016-01-01 12:00:00",
      "auth_provider": "trisk_credentials"
    },
    "relationships": {
      "profile": {
        "data": {
          "type": "users_profile",
          "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
          "attributes": {
            "first_name": "John",
            "last_name": "Doe",
            "avatar": "string",
            "phone_code": "1",
            "phone_number": "(111) 111-11-11",
            "position": "string",
            "created_at": "2016-01-01 12:00:00",
            "updated_at": "2016-01-01 12:00:00"
          }
        }
      }
    }
  }
}

401

Unauthorized exception

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 401,
  "code": 0,
  "title": "Unauthorized"
}

404

The response body of the Not Found Error

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 404,
  "code": 404,
  "title": "Not Found"
}

500

That means something has gone wrong on the server, and the server returns more specific about what the exact problem is

application/vnd.api+json

Schema

Schema

id object
type string

The type of the error

links string[]
status integer

The status of the error

code integer
title string

The title of the error

detail string
source object

The request body

meta object

The internal trace

Example (from schema)

{
  "id": {},
  "type": "errors",
  "links": [
    "string"
  ],
  "status": 0,
  "code": 0,
  "title": "string",
  "detail": "string",
  "source": {},
  "meta": {}
}

Loading...