Documentation Index Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt
Use this file to discover all available pages before exploring further.
Methods
List all users of tenant filtered by query and showInvalidUsers. Pagination is available based on query parameters. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.list( limit = 10 , offset = 10 , query = "value" , show_invalid_users = "value" , ) # Iterate through results for item in response: print (item.name) # Or paginate page by page for page in response.iter_pages(): for item in page: print (item.name)
This endpoint allows tenant administrators to register users within their tenant. Parameters Send invite email if user does not exist
Url to redirect when invite is accepted
Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.pre_register_users( email = "value" , send_invite_email = "value" , skip_if_user_exists = "value" , dry_run = False , accept_invite_client_url = "value" , )
This endpoint allows tenant administrators to update the roles of a user within their tenant. Parameters roles
typing.Sequence[str]
required
Role names for the user
Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.update_roles( email = "value" , roles = "value" , resource_type = "value" , )
Get User associated with provided User id Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.get( id = "id_value" , )
Delete user if they are not a collaborator in any resource and not part of any team other than everyone. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.delete( id = "id_value" , tenant_name = "value" , )
Invite a user to the tenant Parameters Url to redirect when invite is accepted
Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.invite_user( accept_invite_client_url = "value" , email = "value" , )
Deactivate user associated with the provided email within the tenant. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.deactivate( email = "value" , tenant_name = "value" , )
Activate user associated with the provided email within the tenant. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.activate( email = "value" , tenant_name = "value" , )
Change password for the authenticated user. Requires clientId and loginId in the request body. Parameters login id of the user(email)
Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.change_password( login_id = "value" , new_password = "value" , old_password = "value" , )
Get all resources associated with a user. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.get_resources( id = "id_value" , )
Get all role bindings associated with a user, including team-inherited bindings. Parameters Returns GetUserPermissionsResponse
GetUserPermissionsResponse
Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.get_permissions( id = "id_value" , )
Get all teams associated with a user, including their role in each team. Parameters Returns Usage from truefoundry import TrueFoundry client = TrueFoundry( api_key = "YOUR_API_KEY" , base_url = "https://yourhost.com/path/to/api" , ) client.users.get_teams( id = "id_value" , )
