foliolib.folio.users.Users
- class foliolib.folio.users.Users(tenant: str)
Bases:
foliolib.folio.FolioService- Parameters
tenant (str) – Tenant id
Methods
create_user(username, password[, permissions])Create a user
delete_permission(username, permissionName)Delete a permission for a user
delete_permissions(username, permissionNames)Delete a permissions for a user
delete_user(username)Delete a user by username.
get_permissions(username)Get permissions of a user
Get all available service points
get_user(username)Get a user by username
get_users([query])Get all users
get_usersServicePoints(username)Get service points of a user.
login(username, password)Make a authentication.
modify_user(username, userData)Modify a user by username.
set_permission(username, permissionName)Set permission for a user
set_permissions(username, permissionNames)Set permissions for a user
set_servicePoints(username, ...)Set service points for a user.
- create_user(username: str, password: str, permissions: Optional[list] = None, **userdata)
Create a user
- Parameters
username (str) – Username
password (str) – Password
permissions (list, optional) – List with permissions. Defaults to None.
- Returns
Dict with user data
- Return type
dict
- delete_permission(username: str, permissionName: str)
Delete a permission for a user
- Parameters
username (str) – Username
permissionName (str) – Permission name.
- delete_permissions(username: str, permissionNames: list)
Delete a permissions for a user
- Parameters
username (str) – Username
permissionNames (list) – List with permissions.
- delete_user(username: str)
Delete a user by username.
- Parameters
username (str) – Username
- get_permissions(username: str)
Get permissions of a user
- Parameters
username (str) – Username
- Returns
Dict with permissions
- Return type
dict
- get_servicePoints()
Get all available service points
- Returns
Dict with service points
- Return type
dict
- get_user(username: str)
Get a user by username
- Parameters
username (str) – Username
- Raises
UserNotFound – User not found
- Returns
Dict with user data
- Return type
dict
- get_users(query=None)
Get all users
- Returns
Dict with users
- Return type
dic
- get_usersServicePoints(username)
Get service points of a user.
- Returns
Dict with service points
- Return type
dict
- login(username: str, password: str)
Make a authentication.
- Parameters
username (str) – Username
password (str) – Password
- Returns
Instance of the authenticated user. If login failed, None is returned.
- Return type
dict
- modify_user(username: str, userData: dict)
Modify a user by username.
- Parameters
username (str) – Username
- set_permission(username: str, permissionName: str)
Set permission for a user
- Parameters
username (str) – Username
permissionName (str) – Permission name.
- set_permissions(username: str, permissionNames: list)
Set permissions for a user
- Parameters
username (str) – Username
permissionNames (list) – List with permissions.
- set_servicePoints(username: str, servicePointsIds: list, defaultServicePointId: str)
Set service points for a user.
- Parameters
username (str) – Username.
servicePointsIds (list) – List with service point ids.
defaultServicePointId (str) – The default service point of a user.
- Returns
[description]
- Return type
[type]