Users - TrueFoundry Docs

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

🔗 ListUsersResponseReturns all users of tenant and also the response includes paginated data.

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)

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

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",
)

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

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

Get User associated with provided User id

Parameters

str

required

User Id

Returns

GetUserResponse

🔗 GetUserResponseReturns the User associated with provided User id

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

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

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_user

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

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

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

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

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

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

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

Parameters

login id of the user(email)

str

required

New password

str

required

Old password

Returns

ChangePasswordResponse

🔗 ChangePasswordResponsePassword has been changed successfully.

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_resources

Get all resources associated with a user.

Parameters

str

required

User Id

Returns

GetUserResourcesResponse

🔗 GetUserResourcesResponseReturns all resources for the user.

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_permissions

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

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_teams

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

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",
)

​Methods

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage