PUT api/v2/users/list

ListUser

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional information
OrganizationId	universally unique identifier	None.
Email	StringExpressionQueryFilterList	None.
Sort	Collection of ListUserQuerySort	Required Default value:
PageNumber	integer (32 bits)	Required Default value: 1
PageSize	integer (32 bits)	Required Default value: 100

Request Formats

application/json

Sample:

{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "Email": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Sort": [
    "Email",
    "Email"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListUserQueryResult

Name	Description	Type	Additional information
Users		Collection of ListUserQueryResultUser	Required
Count		integer (32 bits)	Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Users": [
    {
      "UserId": "00000000-0000-0000-0000-000000000000",
      "Email": "sample string 1",
      "DisplayName": "sample string 2",
      "Roles": [
        {
          "RoleId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1"
        },
        {
          "RoleId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1"
        }
      ],
      "Settings": {
        "DisplayName": "sample string 1",
        "SignatureText": "sample string 2",
        "FirstName": "sample string 3",
        "MiddleName": "sample string 4",
        "LastName": "sample string 5",
        "Department": "sample string 6",
        "JobTitleDescription": "sample string 7",
        "PhoneNumber": "sample string 8"
      },
      "SignatureUserFileId": "00000000-0000-0000-0000-000000000000"
    },
    {
      "UserId": "00000000-0000-0000-0000-000000000000",
      "Email": "sample string 1",
      "DisplayName": "sample string 2",
      "Roles": [
        {
          "RoleId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1"
        },
        {
          "RoleId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1"
        }
      ],
      "Settings": {
        "DisplayName": "sample string 1",
        "SignatureText": "sample string 2",
        "FirstName": "sample string 3",
        "MiddleName": "sample string 4",
        "LastName": "sample string 5",
        "Department": "sample string 6",
        "JobTitleDescription": "sample string 7",
        "PhoneNumber": "sample string 8"
      },
      "SignatureUserFileId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "Count": 1
}