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

SDK Method

files_sdk.group_user.list()

Return Object

ListObj[GroupUser]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
group_id
int64		Group ID. If provided, will return group_users of this group.
user_id
int64		User ID. If provided, will return group_users of this user.

Additional Arguments

Example Request

import files_sdk

try:
  group_users = files_sdk.group_user.list({
    "group_id": 1
  })
  for group_user in group_users.auto_paging_iter():
    # Operate on group_user
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Group User

SDK Method

files_sdk.group_user.create()

Return Object

GroupUser

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
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?

Example Request

import files_sdk

try:
  group_user = files_sdk.group_user.create({
    "group_id": 1,
    "user_id": 1
  })
  # Operate on group_user
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Update Group User

SDK Method

group_user.update()

Return Object

GroupUser

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
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?

Example Request

import files_sdk

try:
  group_user = files_sdk.group_user.list.first
  group_user.update({
    "group_id": 1,
    "user_id": 1,
    "admin": False
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Group User

SDK Method

group_user.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
group_id
int64
Required		Group ID from which to remove user.
user_id
int64
Required		User ID to remove from group.

Example Request

import files_sdk

try:
  group_user = files_sdk.group_user.list.first
  group_user.delete({
    "group_id": 1,
    "user_id": 1
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The GroupUser Object

Some of the methods above return a GroupUser object. The attributes of this object are listed below.

AttributeDescription
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