> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# User Management

### Overview

<Info>
  **Prerequisites:**

  * This feature is available with the [**Paradime Enterprise pack**](https://www.paradime.io/enterprise).
  * Your API keys ***must*** have either User Management Admin or User Metadata Viewer capabilities.
</Info>

<Info>
  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.
</Info>

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.

<Tabs>
  <Tab title="Args">
    **`none`**
  </Tab>

  <Tab title="Returns">
    *`List[ActiveUser]`*: A list of active user objects.
  </Tab>
</Tabs>

```python theme={"system"}
# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

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

### Get a user by email

Retrieves a user by email.

<Tabs>
  <Tab title="Args">
    **`email`** *`(str)`*: The email of the user to retrieve.
  </Tab>

  <Tab title="Returns">
    *`ActiveUser`*: The user object.
  </Tab>
</Tabs>

```python theme={"system"}
# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

# Get a user by email
user = paradime.users.get_by_email(email="john@acme.io")
```

### Get all invited users

Retrieves all invited users.

<Tabs>
  <Tab title="Args">
    **`none`**
  </Tab>

  <Tab title="Returns">
    *`List[InvitedUser]`*: A list of invited user objects.
  </Tab>
</Tabs>

```python theme={"system"}
# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

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

### Invite a user

Invites a user to the workspace.

<Tabs>
  <Tab title="Args">
    **`email`** *`(str)`*: The email of the user to invite.

    **`account_type`** *`(UserAccountType)`*: The account type of the user to invite.
  </Tab>

  <Tab title="Returns">
    *`none`*
  </Tab>
</Tabs>

```python theme={"system"}
# 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_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.

<Tabs>
  <Tab title="Args">
    **`uid`** *`(str)`*: The ID of the user to update the account type for.

    **`account_type`** *`(UserAccountType)`*: The new account type for the user.
  </Tab>

  <Tab title="Returns">
    *`none`*
  </Tab>
</Tabs>

```python theme={"system"}
# 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_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

# 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.

<Tabs>
  <Tab title="Args">
    **`uid`** *`(str)`*: The ID of the user to disable.
  </Tab>

  <Tab title="Returns">
    *`none`*
  </Tab>
</Tabs>

```python theme={"system"}
# First party modules
from paradime import Paradime

# Create a Paradime client with your API credentials
paradime = Paradime(api_endpoint="API_ENDPOINT", api_secret="prdm_cmp_...", workspace_uid="WORKSPACE_UID")

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


## Related topics

- [Users](/products/settings/users/index.md)
- [User Management API](/developers/graphql-api/api-reference/user-management-api.md)
- [Workspace Management](/developers/python-sdk/modules/workspace-management.md)
- [Workspace Management API](/developers/graphql-api/api-reference/workspace-management-api.md)
- [Manage Users](/products/settings/users/manage-users.md)