Skip to main content

Methods

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

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

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 User associated with provided User id

Parameters

str
required
User Id

Returns

GetUserResponse
🔗 GetUserResponseReturns the User associated with provided User id

Usage

Delete user if they are not a collaborator in any resource and not part of any team other than everyone.

Parameters

str
required
User Id
typing.Optional[str]
Tenant name

Returns

DeleteUserResponse
🔗 DeleteUserResponseUser has been successfully deleted.

Usage

Invite a user to the tenant

Parameters

str
required
Url to redirect when invite is accepted
str
required
Email of user

Returns

InviteUserResponse
🔗 InviteUserResponseUser has been successfully invited.

Usage

Deactivate user associated with the provided email within the tenant.

Parameters

str
required
Email of the user
typing.Optional[str]
Tenant name

Returns

DeactivateUserResponse
🔗 DeactivateUserResponseUser has been successfully deactivated.

Usage

Activate user associated with the provided email within the tenant.

Parameters

str
required
Email of the user
typing.Optional[str]
Tenant name

Returns

ActivateUserResponse
🔗 ActivateUserResponseUser has been successfully activated.

Usage

Change password for the authenticated user. Requires clientId and loginId in the request body.

Parameters

str
required
login id of the user(email)
str
required
New password
str
required
Old password

Returns

ChangePasswordResponse
🔗 ChangePasswordResponsePassword has been changed successfully.

Usage

Get all resources associated with a user.

Parameters

str
required
User Id

Returns

GetUserResourcesResponse
🔗 GetUserResourcesResponseReturns all resources for the user.

Usage

Get all role bindings associated with a user, including team-inherited bindings.

Parameters

str
required
User Id

Returns

GetUserPermissionsResponse
🔗 GetUserPermissionsResponseReturns role bindings for the user (including team-inherited).

Usage

Get all teams associated with a user, including their role in each team.

Parameters

str
required
User Id

Returns

GetUserTeamsResponse
🔗 GetUserTeamsResponseReturns all teams for the user with their roles.

Usage