Sha256: 917ff929a6e19b9bfef6b98cd33691b682882c535e556532b9d90ae6bba49338
Contents?: true
Size: 1.95 KB
Versions: 16
Compression:
Stored size: 1.95 KB
Contents
# GroupUser
## Example GroupUser Object
```
{
"group_name": "My Group",
"group_id": 1,
"user_id": 1,
"admin": true,
"usernames": [
]
}
```
* `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?
* `usernames` (array): A list of usernames for users in this group
* `id` (int64): Group User ID.
---
## List Group Users
```
Files::GroupUser.list(
user_id: 1,
page: 1,
per_page: 1,
group_id: 1
)
```
### Parameters
* `user_id` (int64): User ID. If provided, will return group_users of this user.
* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
* `group_id` (int64): Group ID. If provided, will return group_users of this group.
---
## Update Group User
```
Files::GroupUser.update(id,
group_id: 1,
user_id: 1,
admin: true
)
```
### Parameters
* `id` (int64): Required - Group User ID.
* `group_id` (int64): Required - Group ID to add user to.
* `user_id` (int64): Required - User ID to add to group.
* `admin` (boolean): Is the user a group administrator?
---
## Delete Group User
```
Files::GroupUser.delete(id)
```
### Parameters
* `id` (int64): Required - Group User ID.
---
## Update Group User
```
group_user = Files::GroupUser.list_for(path).first
group_user.update(
group_id: 1,
user_id: 1,
admin: true
)
```
### Parameters
* `id` (int64): Required - Group User ID.
* `group_id` (int64): Required - Group ID to add user to.
* `user_id` (int64): Required - User ID to add to group.
* `admin` (boolean): Is the user a group administrator?
---
## Delete Group User
```
group_user = Files::GroupUser.list_for(path).first
group_user.delete
```
### Parameters
* `id` (int64): Required - Group User ID.
Version data entries
16 entries across 16 versions & 1 rubygems