Get User Group

This endpoint returns the details of a user group.

Request

GET https://v2.api.uberflip.com/user-groups/{groupId}

Path Parameters	Description
groupId	The unique identifier of the user group

Response

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

Examples

curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/user-groups/{groupId}

Sample response:

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

{
    "id": 1,
    "code": null,
    "name": "groupname",
    "description": "description",
    "user_count": null,
    "lock_update": null,
    "lock_delete": null,
    "lock_grant_revoke_global_permissions": null,
    "lock_grant_revoke_licenses": null,
    "lock_add_remove_users": null,
    "created_at": "2018-11-22T12:00:00-0500",
    "modified_at": "2018-11-22T12:00:00-0500"
}