User Management

Overview

Prerequisites:

This feature is available with the Paradime Enterprise pack.
Your API keys must have either User Management Admin or User Metadata Viewer capabilities.

These examples authenticate with an account API key (api_secret="prdm_cmp_..." plus workspace_uid), which requires paradime-io 6.0.0 or later. Legacy workspace API keys (api_key + api_secret) are still supported. See Getting Started.

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.

List[ActiveUser]

A list of active user objects.

from paradime import Paradime

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

active_users = paradime.users.list_active()

Get a user by email

Retrieves a user by email.

str

required

The email of the user to retrieve.

ActiveUser

The user object.

from paradime import Paradime

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

user = paradime.users.get_by_email(email="john@acme.io")

Get all invited users

Retrieves all invited users.

List[InvitedUser]

A list of invited user objects.

from paradime import Paradime

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

invited_users = paradime.users.list_invited()

Invite a user

Invites a user to the workspace.

str

required

The email of the user to invite.

UserAccountType

required

The account type of the user to invite.

None

This method returns nothing.

from paradime import Paradime
from paradime.apis.users.types import UserAccountType

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

# Invite a user as an admin
paradime.users.invite(email="bhuvan@paradime.io", account_type=UserAccountType.ADMIN)

Update a user’s account type

Updates the account type of a user.

str

required

The ID of the user to update the account type for.

UserAccountType

required

The new account type for the user.

None

This method returns nothing.

from paradime import Paradime
from paradime.apis.users.types import UserAccountType

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

paradime.users.update_account_type(user_uid=user.uid, account_type=UserAccountType.DEVELOPER)

Disable a user

Disable a user in the workspace.

str

required

The ID of the user to disable.

None

This method returns nothing.

from paradime import Paradime

paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

paradime.users.disable(user_uid=user.uid)

API Keys & Access

GraphQL API

Python SDK

Paradime CLI

Webhooks

Virtual Environments

Overview

Get all active users

Get a user by email

Get all invited users

Invite a user

Update a user’s account type

Disable a user

​Overview

​Get all active users

​Get a user by email

​Get all invited users

​Invite a user

​Update a user’s account type

​Disable a user

Overview

Get all active users

Get a user by email

Get all invited users

Invite a user

Update a user’s account type

Disable a user