Skip to content

POST /a/user

List/Search users

Body Parameters

Name Description Type Required
CountOnly Return counts only, no actual results boolean
GroupBy integer
Limit Limit number of results string
Offset Start listing at a given position string
Operation Combine single queries with AND or OR logic #/definitions/serviceOperationType
Queries Atomic queries that will be combined using the Operation Type (AND or OR) array
ResourcePolicyQuery Policies queries to filter the search context #/definitions/restResourcePolicyQuery

Body Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "CountOnly": true,
  "GroupBy": 10,
  "Limit": "string",
  "Offset": "string",
  "Operation": "string",
  "Queries": [
    {
      "AttributeAnyValue": true,
      "AttributeName": "string",
      "AttributeValue": "string",
      "ConnectedSince": "string",
      "FullPath": "string",
      "GroupPath": "string",
      "HasProfile": "string",
      "HasRole": "string",
      "Login": "string",
      "NodeType": "string",
      "Password": "string",
      "Recursive": true,
      "Uuid": "string",
      "not": true
    }
  ],
  "ResourcePolicyQuery": {
    "Type": "string",
    "UserId": "string"
  }
}

Response Example (200)

Response Type /definitions/restUsersCollection

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
{
  "Groups": [
    {
      "Attributes": {},
      "GroupLabel": "string",
      "GroupPath": "string",
      "IsGroup": true,
      "LastConnected": 10,
      "Login": "string",
      "OldPassword": "string",
      "Password": "string",
      "Policies": [
        {
          "Action": "string",
          "Effect": "string",
          "JsonConditions": "string",
          "Resource": "string",
          "Subject": "string",
          "id": "string"
        }
      ],
      "PoliciesContextEditable": true,
      "Roles": [
        {
          "AutoApplies": [
            "string"
          ],
          "ForceOverride": true,
          "GroupRole": true,
          "IsTeam": true,
          "Label": "string",
          "LastUpdated": 10,
          "Policies": [
            {
              "Action": "string",
              "Effect": "string",
              "JsonConditions": "string",
              "Resource": "string",
              "Subject": "string",
              "id": "string"
            }
          ],
          "PoliciesContextEditable": true,
          "UserRole": true,
          "Uuid": "string"
        }
      ],
      "Uuid": "string"
    }
  ],
  "Total": 10,
  "Users": [
    {
      "Attributes": {},
      "GroupLabel": "string",
      "GroupPath": "string",
      "IsGroup": true,
      "LastConnected": 10,
      "Login": "string",
      "OldPassword": "string",
      "Password": "string",
      "Policies": [
        {
          "Action": "string",
          "Effect": "string",
          "JsonConditions": "string",
          "Resource": "string",
          "Subject": "string",
          "id": "string"
        }
      ],
      "PoliciesContextEditable": true,
      "Roles": [
        {
          "AutoApplies": [
            "string"
          ],
          "ForceOverride": true,
          "GroupRole": true,
          "IsTeam": true,
          "Label": "string",
          "LastUpdated": 10,
          "Policies": [
            {
              "Action": "string",
              "Effect": "string",
              "JsonConditions": "string",
              "Resource": "string",
              "Subject": "string",
              "id": "string"
            }
          ],
          "PoliciesContextEditable": true,
          "UserRole": true,
          "Uuid": "string"
        }
      ],
      "Uuid": "string"
    }
  ]
}

Auto generated by Pydio Cells Enterprise Distribution v4.4.13 on 7-May-2025