GET /v3/users

Logged user MUST have right Manage users. Request CAN contain pagination parameters. Incorrect or unsupported filter will return empty result.

URL parameters can be used to filter the result.

Name

Type

Description

limit

integer

Default value : 100

start

integer

Offset for the limit

Default value : 0

include

string

Include additional properties.

Available:

  • aliases

  • delegates

  • policies

  • accounts

  • permissions

Default value :

Example : aliases,accounts

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Type: client, user
Scopes: [ users ]

Response body:
{
  "users":[],
  "count": 0
}
CODE


GET /v3/users/find

Logged user MUST have right Manage users. Request MUST contain at least one of required filter. Incorrect or unsupported filter will return empty result.

URL parameters can be used to filter the result.

Name

Type

Description

email

string

An Email of the User.

username

string

An Username or Alias of the User.

card

string

One of the Card of the User.

code

string

The Code (personal number) of the User.

syncSource

string

The Synchronization source of the User.

isActive

integer

The state(active or inactive) of the User.

Default value : 1

group

string

The group of the User. Ex. Group or Group|SubGroup. Separator set in MyQ must be used (| for newer installations).

limit

integer

Default value : 100

start

integer

Offset for the limit

Default value : 0

include

string

Include additional properties.

Available:

  • aliases

  • delegates

  • policies

  • accounts

  • permissions

Default value :

Example : aliases,accounts

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Type: client
Scopes: []

Response body:
{
  "users":[],
  "count": 0
}
CODE


GET /v3/users/{id}

Logged user MUST have right Manage users to be able to retrieve different user. {id} must by replaced by the id of the user.

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Type: client, user
Scopes: [ users ]

Response body:
{
  "id": 0,
  "username": "string",
  "fullname": "string",
  "email": "string",
  "scanStorage": "string",
  "code": "string",
  "syncSource": "string",
  "lang": "string",
  "phone": "string",
  "ldapDomain": "string",
  "notes": "string"
}
NONE


GET /v3/users/me

Get the logged user.

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Type: user 
Scopes: []

Response body:
{
  "id": 0,
  "username": "string",
  "fullname": "string",
  "email": "string",
  "scanStorage": "string",
  "code": "string",
  "syncSource": "string",
  "lang": "string",
  "phone": "string",
  "ldapDomain": "string",
  "notes": "string"
}
CODE