Skip to main content

UserCollection Schema

Data structure for User Collection objects.

Item Type​

This is a collection (list) of User items.

Usage​

# Example: Working with UserCollection
items = [
    {"admin_user":true,"comments":"comments-value-1","deleted":true,"department":{"comments":"comments-value-1","deleted":true,"id":1},"disabled":true},
    {"admin_user":true,"comments":"comments-value-2","deleted":true,"department":{"comments":"comments-value-2","deleted":true,"id":2},"disabled":true}
]

# Pass to an action that requires this collection type
resource.some_action(body=items)

JSON Example​

[
  {
    "admin_user": true,
    "comments": "comments-value-1",
    "deleted": true,
    "department": {
      "comments": "comments-value-1",
      "deleted": true,
      "id": 1
    },
    "disabled": true
  },
  {
    "admin_user": true,
    "comments": "comments-value-2",
    "deleted": true,
    "department": {
      "comments": "comments-value-2",
      "deleted": true,
      "id": 2
    },
    "disabled": true
  }
]