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>"

[
  {
    "id": 1,
    "username": "user@example-iot-org.com",
    "name": "Douglas Adams",
    "created": "2019-10-12T08:00:00.000Z",
    "status": {
      "id": 2,
      "description": "Suspended"
    },
    "organisation": {
      "id": 10,
      "name": "Example IoT Org"
    },
    "mfa": [
      {
        "activation_date": "2019-02-04T09:14:13.000Z",
        "creation_date": "2019-02-03T14:04:03.000Z",
        "id": 2,
        "status": {
          "id": 1,
          "name": "Active"
        },
        "type": {
          "id": 0,
          "name": "Time-Based One-Time Password"
        }
      }
    ]
  },
  {
    "id": 2,
    "username": "admin@example-iot-org.com",
    "name": "Edwin Abbott",
    "created": "2019-08-31T16:47:00.000Z",
    "status": {
      "id": 1,
      "description": "Active"
    },
    "organisation": {
      "id": 10,
      "name": "Example IoT Org"
    }
  }
]

User + List

Roles: Administrator

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

<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` + `List` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info> 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

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

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-PageintegerOptional

The requested per_page parameter

X-Current-PageintegerOptional

The current page number within the current data set

X-Total-CountintegerOptional

The total element count in the current data set

X-Total-PagesintegerOptional

The total page count in the current data set

X-FilterstringOptional

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

X-SortstringOptional

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

Response

Successfully returned a list of Users

idintegerOptional

usernamestringOptional

namestringOptional

createdstringOptional

statusobjectOptional

organisationobjectOptional

Errors

403

Forbidden Error