List user accounts

GET

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

GET

/api/v1/user

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

200Default - List All Users

1 [
2   {
3     "id": 1,
4     "username": "user@example-iot-org.com",
5     "name": "Douglas Adams",
6     "created": "2019-10-12T08:00:00.000Z",
7     "status": {
8       "id": 2,
9       "description": "Suspended"
10     },
11     "organisation": {
12       "id": 10,
13       "name": "Example IoT Org"
14     },
15     "mfa": [
16       {
17         "id": 2,
18         "type": {
19           "id": 0,
20           "name": "Time-Based One-Time Password"
21         },
22         "status": {
23           "id": 1,
24           "name": "Active"
25         },
26         "creation_date": "2019-02-03T14:04:03.000Z",
27         "activation_date": "2019-02-04T09:14:13.000Z"
28       }
29     ]
30   },
31   {
32     "id": 2,
33     "username": "admin@example-iot-org.com",
34     "name": "Edwin Abbott",
35     "created": "2019-08-31T16:47:00.000Z",
36     "status": {
37       "id": 1,
38       "description": "Active"
39     },
40     "organisation": {
41       "id": 10,
42       "name": "Example IoT Org"
43     }
44   }
45 ]

Retrieves the collection of user accounts, filtered, sorted and paged accourding to query parameters.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Query parameters

pagedoubleOptional

Current page number

qstringOptionalformat: "(id|status|name|username|organisation):.+"

Filter parameter in `<filter>:<value>` format. Multiple filters must be in the format of a comma separated list of the following fields: * `id` * `status` * `name` * `username` * `organisation`

per_pageintegerOptional

Defines the number of items per page

Sort parameter in `<operator><field>` format. Expects a comma-separated list from the allowed fields: * `id` * `status` * `name` * `username` * `organisation` * `created`

Response headers

X-Count-Per-Pageinteger

The requested per_page parameter

X-Current-Pageinteger

The current page number within the current data set

X-Total-Countinteger

The total element count in the current data set

X-Total-Pagesinteger

The total page count in the current data set

X-Filterstring

If filtering is applied using ?q=field:criteria URL query parameters, the filter criteria is returned here

X-Sortstring

If sorting is applied using ?sort=sort_criteria URL query parameters, the sort criteria is returned here

Response

Successfully returned a list of Users

idinteger

usernamestring

namestring

createdstring

statusobject

organisationobject

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

1	[
2	{
3	"id": 1,
4	"username": "user@example-iot-org.com",
5	"name": "Douglas Adams",
6	"created": "2019-10-12T08:00:00.000Z",
7	"status": {
8	"id": 2,
9	"description": "Suspended"
10	},
11	"organisation": {
12	"id": 10,
13	"name": "Example IoT Org"
14	},
15	"mfa": [
16	{
17	"id": 2,
18	"type": {
19	"id": 0,
20	"name": "Time-Based One-Time Password"
21	},
22	"status": {
23	"id": 1,
24	"name": "Active"
25	},
26	"creation_date": "2019-02-03T14:04:03.000Z",
27	"activation_date": "2019-02-04T09:14:13.000Z"
28	}
29	]
30	},
31	{
32	"id": 2,
33	"username": "admin@example-iot-org.com",
34	"name": "Edwin Abbott",
35	"created": "2019-08-31T16:47:00.000Z",
36	"status": {
37	"id": 1,
38	"description": "Active"
39	},
40	"organisation": {
41	"id": 10,
42	"name": "Example IoT Org"
43	}
44	}
45	]