List Users

SaaS only

This API is Applicable only for SaaS Environment

This API can be used by MSP Partners to list users with filtering. sort and pagination support.

Response Body

Field	Description	Type	Notes
data	List of Users	User Objects (Get Use by Id - Response Body) Array	See - Get User by Id - User Object (Response Body)
metadata	List user metadata	Metadata Object	See - Metadata Object

Metadata Object

Field	Description	Type	Notes
filter	Filter string that contains search parameters	String
sort	Sort string that contains sorting criteria	String
pagination	Pagination Info	Pagination Object	See - Pagination Object

Pagination Object

Field	Description	Type	Notes
pageNumber	Page number	Integer	0 to x
pageSize	Page size	Integer
totalRecords	Total number of records	Integer

Query Parameters

• filter string

  Optional - Filter. Only searchTerm supported which matches user firstName lastName and email containing searchTerm value.

• sort string

  Optional - Sort order. default desc:updateTs

• pageNumber int32

  Optional - Page number >=0. default 0

• pageSize int32

  Optional - Size of each page. default 25

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• List User - Success

---

Schema

• data object[]

  id string

  insertTs string

  updateTs string

  email string

  firstName string

  lastName string

  roles string[]

  managedAccounts string[]

  status string
• metadata object

  filter string

  sort string

  pagination object

  pageNumber int32

  pageSize int32

  totalRecords int32

{
  "data": [
    {
      "id": "537FBFE1-88F4-480F-9063-2F6426536684",
      "insertTs": "2022-01-19T19:23:44",
      "updateTs": "2022-01-19T23:01:03",
      "email": "hanna@partnerx.com",
      "firstName": "Hanna",
      "lastName": "Smith",
      "roles": [
        "ROLE_MSP_ADMIN"
      ],
      "managedAccounts": [
        "*"
      ],
      "status": "updating"
    }
  ],
  "metadata": {
    "filter": "filter=searchTerm:hanna",
    "sort": "desc:updateTs",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 25,
      "totalRecords": 1
    }
  }
}

{
  "data": [
    {
      "id": "537FBFE1-88F4-480F-9063-2F6426536684",
      "insertTs": "2022-01-19T19:23:44",
      "updateTs": "2022-01-19T23:01:03",
      "email": "hanna@partnerx.com",
      "firstName": "Hanna",
      "lastName": "Smith",
      "roles": [
        "ROLE_MSP_ADMIN"
      ],
      "managedAccounts": [
        "*"
      ],
      "status": "updating"
    }
  ],
  "metadata": {
    "filter": "filter=searchTerm:hanna",
    "sort": "desc:updateTs",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 25,
      "totalRecords": 1
    }
  }
}

Loading...