Methods
list
list
List all users of tenant filtered by query and showInvalidUsers. Pagination is available based on query parameters.
Parameters
typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip
typing.Optional[str]
typing.Optional[bool]
Show Deactivated users
Returns
SyncPager[User, ListUsersResponse]
🔗 ListUsersResponseReturns all users of tenant and also the response includes paginated data.
Usage
pre_register_users
pre_register_users
This endpoint allows tenant administrators to register users within their tenant.
Parameters
str
required
Email of the user
typing.Optional[bool]
Send invite email if user does not exist
typing.Optional[bool]
Fail if user exists
typing.Optional[bool]
Dry run
typing.Optional[str]
Url to redirect when invite is accepted
Returns
RegisterUsersResponse
🔗 RegisterUsersResponseThe users have been successfully registered.
Usage
update_roles
update_roles
This endpoint allows tenant administrators to update the roles of a user within their tenant.
Parameters
str
required
Email of the user
typing.Sequence[str]
required
Role names for the user
typing.Optional[str]
Resource Type
Returns
UpdateUserRolesResponse
🔗 UpdateUserRolesResponseThe user roles have been successfully updated.
Usage
get
get
delete
delete
invite_user
invite_user
deactivate
deactivate
activate
activate
change_password
change_password
get_resources
get_resources
get_permissions
get_permissions