Get user by ID or username

GET

https://cdn.emnify.net/api/v1/user/:user_id

GET

/api/v1/user/:user_id

$ curl https://cdn.emnify.net/api/v1/user/1.1 \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": 123,
3   "username": "eabbot@flatland.org",
4   "name": "Edwin Abbott",
5   "created": "2019-08-31T16:47:00.000Z",
6   "status": {
7     "description": "Active",
8     "id": 1
9   },
10   "organisation": {
11     "id": 123,
12     "name": "Company"
13   },
14   "roles": [
15     {
16       "id": 2,
17       "name": "User"
18     },
19     {
20       "id": 3,
21       "name": "Observer"
22     }
23   ],
24   "mfa": [
25     {
26       "activation_date": "2017-02-04T09:14:13.000Z",
27       "creation_date": "2017-02-03T14:04:03.000Z",
28       "id": 12,
29       "status": {
30         "id": 1,
31         "name": "Active"
32       },
33       "type": {
34         "id": 0,
35         "name": "Time-Based One-Time Password"
36       }
37     }
38   ]
39 }

User + Get

Roles: Administrator

Get a specific user by ID provided the user is within this requesting user’s organisation or the organisation’s immediate child organisations.

id may be one of:

The numeric ID of the user, e.g. “123”. This is the top-level id object returned by each item in GET /api/v1/user
Username (email), e.g. “exampleuser@org.de”. This is the top-level username object returned by each item in GET /api/v1/user

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `User` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info> Get a specific user by ID provided the user is within this requesting user's organisation or the organisation's immediate child organisations. `id` may be one of: * The numeric ID of the user, e.g. "123". This is the top-level `id` object returned by each item in `GET /api/v1/user` * Username (email), e.g. "exampleuser@org.de". This is the top-level `username` object returned by each item in `GET /api/v1/user`

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

user_iddoubleRequired

User ID

Response

Success

idintegerOptional

usernamestringOptional

namestringOptional

createdstringOptional

statusobjectOptional

organisationobjectOptional

roleslist of objectsOptional

mfalist of objectsOptional

Errors

403

Forbidden Error

404

Not Found Error