UsersV1

Get users

Returns list of users that belongs to the same domain.

get/users/v1

Request

  • Base URL: https://api.danalock.com
  • URL: https://api.danalock.com/users/v1
  • Auth: OAuth 2 (authorization code, authorization URL /oauth2/authorize, token URL /oauth2/token)

Query parameters

anystring

Filter by username OR display_name OR email_address OR alias.

usernamestring

Filter by username.

display_namestring

Filter by display_name.

email_addressstring

Filter by email_address.

aliasstring

Filter by alias.

pageinteger

Requested page number

Headers

X-Assume-Userstring

Assume the identity of the user in another domain

Response

users

idstring required
usernamestring required
display_namestring required
rolestring required
email_addressstring required
aliasstring required
is_shadow_userboolean required

Example response

[
  {
    "id": "user-7646c328e9d8",
    "username": "user@example.com",
    "display_name": "John Doe",
    "role": "User",
    "email_address": "user@example.com",
    "alias": "user@example.com"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.