Users

list

List all users of tenant filtered by query and showInvalidUsers. Pagination is available based on query parameters.

Parameters

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

query

typing.Optional[str]

No description

show_invalid_users

typing.Optional[bool]

Show Deactivated users

Returns

Returns all users of tenant and also the response includes paginated data.Type Details: User

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.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 pre-register users within their tenant.

Parameters

emails

typing.Sequence[str]

required

Emails of the users

dry_run

typing.Optional[bool]

Dry run

Returns

PreRegisterUsersResponse

The users have been successfully pre-registered.Type Details: PreRegisterUsersResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.pre_register_users(
    emails="value",
    dry_run=False,
)

update_roles

This endpoint allows tenant administrators to update the roles of a user within their tenant.

Parameters

email

str

required

Email of the user

roles

typing.Sequence[str]

required

Roles for the user

Returns

UpdateUserRolesResponse

The user roles have been successfully updated.Type Details: UpdateUserRolesResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.update_roles(
    email="value",
    roles="value",
)

get

Get User associated with provided User id

Parameters

id

str

required

User Id

Returns

GetUserResponse

Returns the User associated with provided User idType Details: GetUserResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.get(
    id="id_value",
)

invite_user

Invite a user to the tenant

Parameters

accept_invite_client_url

str

required

Url to redirect when invite is accepted

email

str

required

Email of user

Returns

InviteUserResponse

User has been successfully invited.Type Details: InviteUserResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.invite_user(
    accept_invite_client_url="value",
    email="value",
)

deactivate

Deactivate user associated with the provided email within the tenant.

Parameters

email

str

required

Email of the user

Returns

DeactivateUserResponse

User has been successfully deactivated.Type Details: DeactivateUserResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.deactivate(
    email="value",
)

activate

Activate user associated with the provided email within the tenant.

Parameters

email

str

required

Email of the user

Returns

ActivateUserResponse

User has been successfully activated.Type Details: ActivateUserResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.activate(
    email="value",
)

change_password

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

Parameters

login id of the user(email)

new_password

str

required

New password

old_password

str

required

Old password

Returns

ChangePasswordResponse

Password has been changed successfully.Type Details: ChangePasswordResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.change_password(
    login_id="value",
    new_password="value",
    old_password="value",
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Methods

Methods