Group Users
A GroupUser is a record about membership of a User within a Group.
Creating GroupUsers
GroupUsers can be created via the normal create action. When using the update action, if the
GroupUser record does not exist for the given user/group IDs it will be created.
List Group Users
Command
files-cli group-users list
Output
Outputs a list of GroupUser objects according to the output format.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
Parameter access is subject to this endpoint's authorization requirement and the caller's access to the affected resource. Site Administrator access also includes Site-Wide API keys.
| Flag | Description |
|---|---|
| --group-id= int64 | Group ID. If provided, returns memberships of this group. Requires a Site Administrator, a Read-only Administrator, a Workspace Administrator for the group's workspace, or a Group Administrator of this group. |
| --user-id= int64 | User ID. If provided, will return group_users of this user. Can be set by: Site Administrator; Read-only Administrator; Workspace Administrator. |
Additional Arguments
Create Group User
Command
files-cli group-users create
Output
Outputs a GroupUser object according to the output format.
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Group Administrator for the relevant group.
Flags
Parameter access is subject to this endpoint's authorization requirement and the caller's access to the affected resource. Site Administrator access also includes Site-Wide API keys.
| Flag | Description |
|---|---|
| --group-id= int64 Required | Group ID to add user to. Can be set by: Site Administrator; Workspace Administrator; Group Administrator. |
| --user-id= int64 Required | User ID to add to group. Can be set by: Site Administrator; Workspace Administrator; Group Administrator. |
| --admin boolean | Is the user a group administrator? Can be set by: Site Administrator; Workspace Administrator. |
Update Group User
Command
files-cli group-users update
Output
Outputs a GroupUser object according to the output format.
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Group Administrator for the relevant group.
Flags
Parameter access is subject to this endpoint's authorization requirement and the caller's access to the affected resource. Site Administrator access also includes Site-Wide API keys.
| Flag | Description |
|---|---|
| --id= int64 Required | Group User ID. Can be set by: Site Administrator; Workspace Administrator; Group Administrator. |
| --group-id= int64 Required | Group ID to add user to. Can be set by: Site Administrator; Workspace Administrator; Group Administrator. |
| --user-id= int64 Required | User ID to add to group. Can be set by: Site Administrator; Workspace Administrator; Group Administrator. |
| --admin boolean | Is the user a group administrator? Can be set by: Site Administrator; Workspace Administrator. |
Delete Group User
Command
files-cli group-users delete
Output
No output is returned.
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Group Administrator for the relevant group.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Group User ID. |
| --group-id= int64 Required | Group ID from which to remove user. |
| --user-id= int64 Required | User ID to remove from group. |
The GroupUser Object
Some of the commands above return a GroupUser object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| group_name string | Group name |
| group_id int64 | Group ID |
| user_id int64 | User ID |
| admin boolean | Is this user an administrator of this group? |
| username string | Username of the user |