foliolib.folio.permissionsImpl.PermissionsImpl

class foliolib.folio.permissionsImpl.PermissionsImpl(tenant: str)

Bases: foliolib.folio.FolioAPIImpl

Implentations of permissions related functions.

Methods

`add_user`(userId[, permissions])	Add a permissionUser.
`delete_permission_for_user`(userId, ...)	Delete a permission by permissionName for a user.
`delete_user`(userId)	Delete a permissionUser.
`get_permission`(name_or_id)	Get a permission by permissionName or id
`get_permissions`([query])	Get permissions by query or get all permissions.
`get_permissions_for_user`(userId)	Get permissions fof a user.
`get_topLevelPermissions`()	Get all available top level permissions.
`get_user`(userId)	Get a permissionUser by user id.
`get_users`([query])	Get permissionUsers.
`set_permission_for_user`(userId, permissionName)	Set a permission by permissionName for a user.

add_user(userId: str, permissions: list = None)

Add a permissionUser.

Parameters

userId (str) – user id.
permissions (list, optional) – List of permissionNames. Defaults to None.

delete_permission_for_user(userId: str, permissionName: str)

Delete a permission by permissionName for a user.

Raises

PermissionUserNotFound – User not found.

Parameters

delete_user(userId: str)

Delete a permissionUser.

get_permission(name_or_id)

Get a permission by permissionName or id

get_permissions(query: str = None)

Get permissions by query or get all permissions.

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

get_permissions_for_user(userId: str)

Get permissions fof a user.

get_topLevelPermissions()

Get all available top level permissions.

get_user(userId: str)

Get a permissionUser by user id.

get_users(query: str = None)

Get permissionUsers.

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

set_permission_for_user(userId: str, permissionName: str)

Set a permission by permissionName for a user.

Raises

PermissionUserNotFound – User not found.

Parameters