User Groups Management
- class nc_py_api.users_groups._UsersGroupsAPI(session: NcSessionBasic)[source]
Class providing an API for managing user groups on the Nextcloud server.
Note
In NextcloudApp mode, only
get_list
andget_details
methods are available.- get_list(mask: str | None = None, limit: int | None = None, offset: int | None = None) list[str] [source]
Returns a list of user groups IDs.
- get_details(mask: str | None = None, limit: int | None = None, offset: int | None = None) list[GroupDetails] [source]
Returns a list of user groups with detailed information.
- class nc_py_api.users_groups.GroupDetails(raw_data: dict)[source]
User Group information.
- property group_id: str
ID of the group.
- property display_name: str
A display name of the group.
- property user_count: int
Number of users in the group.
- property disabled: bool
Flag indicating is group disabled.
- property can_add: bool
Flag indicating the caller has enough rights to add users to this group.
- property can_remove: bool
Flag indicating the caller has enough rights to remove users from this group.