foliolib.folio.usersImpl.GroupsImpl

class foliolib.folio.usersImpl.GroupsImpl(tenant: str)

Bases: foliolib.folio.FolioAPIImpl

Implentations of groups related functions.

Methods

add_group(name: str, **kwargs)

Add a group.

Parameters

name (str) – Name of the group.

Keyword Arguments

uuid (str) – Id of the group.
desc (str) – Description of the group. Defaults to None.
expirationOffsetInDays (int) – Expiration offset days. Defaults to 0.
source – (str): Origin of the group record, i.e. ‘System’ or ‘User’”. Defaults to None.

Returns

Object of the group.

Return type

dict

delete_group(name_or_id: str)

Delete a group.

get_group(name_or_id: str)

Get group by given name or id.

get_groups(query: str = None)

Get list of groups.

Parameters: query (str, optional) – CQL string. Default to None, all objects will be returned.
Returns: List of group Objects.
Return type: list

modify_group(name: str, **kwargs)

Modify a group.

In order to change the name of the group, the uuid of the group must be given.