Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": 123,
            "code": "ALL_USERS",
            "name": "All Users",
            "description": "All users in your account are automatically added to this group.",
            "user_count": 11,
            "lock_update": 1,
            "lock_delete": 1,
            "lock_grant_revoke_global_permissions": 0,
            "lock_grant_revoke_licenses": 0,
            "lock_add_remove_users": 1,
            "created_at": "2017-07-04T12:36:39-0400",
            "modified_at": "2017-07-04T12:36:39-0400"
        }
    ],
    "meta": {
        "count": 1,
        "limit": 25,
        "total_pages": 1
    }
}

The response will contain a users collection:

Body Parameters

Type

Description

data

Array

The collection of user groups

meta

Object

See: Pagination

Each user group in the collection will have properties:

Body Parameters

Type

Description

id

Integer

The user group identifier

code

String

The user group code

name

String

The user group name

description

String

The user group description

user_count

Integer

The number of users included in the user group

lock_delete

Boolean

The user group cannot be deleted if this lock is set

lock_grant_revoke_global_permissions

Boolean

lock_grant_revoke_licenses

Boolean

lock_add_remove_users

Boolean

Users cannot be removed from this user group if this lock is set

created_at

DateTime

The user group creation time

modified_at

DateTime

The user group last updated time