User Management

Overview

• This feature is available with the Paradime Enterprise pack.

• Your API keys must have either User Management Admin or User Metadata Viewer capabilities.

The User Management module enables you to efficiently administer and regulate user access within your workspace.

This module offers a comprehensive set of tools to list all users, send invitations to new members, disable users' accounts, and precisely control users' roles and permissions.

Get all active users

Retrieves all active users.

Args

none

Returns

List[ActiveUser]: A list of active user objects.

# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Get all active users
active_users = paradime.users.list_active()

Get a user by email

Retrieves a user by email.

Args

email (str): The email of the user to retrieve.

Returns

ActiveUser: The user object.

# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Get a user by email
user = paradime.users.get_by_email(email="[email protected]")

Get all invited users

Retrieves all invited users.

Args

none

Returns

List[InvitedUser]: A list of invited user objects.

# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Get all invited users
invited_users = paradime.users.list_invited()

Invite a user

Invites a user to the workspace.

Args

email (str): The email of the user to invite.

account_type (UserAccountType): The account type of the user to invite.

Returns

none

# First party modules
from paradime import Paradime
from paradime.apis.users.types import UserAccountType

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Invite a user as an admin
paradime.users.invite(email="[email protected]", account_type=UserAccountType.ADMIN)

Update a user's account type

Updates the account type of a user.

Args

uid (str): The ID of the user to update the account type for.

account_type (UserAccountType): The new account type for the user.

Returns

none

# First party modules
from paradime import Paradime
from paradime.apis.users.types import UserAccountType

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Update a user's account type
paradime.users.update_account_type(user_uid=user.uid, account_type=UserAccountType.DEVELOPER)

Disable a user

Disable a user in the workspace.

Args

uid (str): The ID of the user to disable.

Returns

none

# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_key="API_KEY", api_secret="API_SECRET")

# Disable a user
paradime.users.disable(user_uid=user.uid)