Skip to main content

Group

Schema

AttributeDescription
uuidUnique ID
nameName of the group.
descriptionDescription for the group.
data_sourceSource where group information was fetched. For locally created users,
this value is LOCAL, otherwise it indicates the IdP source.
create_timeCreation time of the group (for groups, Lacework Edge gets from IdPs, this
value indicates the creation time in IdP sources.
update_timeLast update time for the group object.
user_countNumber of users that are part of the group.
statusStatus can be ACTIVE, SUSPENDED.

Create a LOCAL group

CLI

Create a json file, say create-group.json, with contents as follows:

{
"name": "<name of the group>",
"description": "<description for the group>",
}

Running egcli to create the group (assumes token is present in environment variable)

./egcli nervecenter --address nerve-grpc.edge-guardian.io:443 create-group \
--from_file create-group.json

REST API

POST /api/v1/groups

Body

{
"name": "<name of the group>",
"description": "<description for the group>",
}

Query all groups in your account

CLI

Running following egcli command will return all groups in your account.

./egcli nervecenter --address nerve-grpc.edge-guardian.io:443 query-groups

REST API

GET /api/v1/groups

Get specific group

CLI

Running following egcli command will return all attributes for specified group UUID.

./egcli nervecenter --address nerve-grpc.edge-guardian.io:443 get-group --uuid <UUID>

REST API

GET /api/v1/groups/:group_uuid