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

# Zoom User Provisioning & Deprovisioning

> Automate Zoom user provisioning and deprovisioning from your HRIS. Klef creates, updates, and deactivates accounts when HR makes a change.

![](https://mintcdn.com/klef/O1Sswmcb_uCGkmIf/images/connectors/zoom.svg?fit=max\&auto=format\&n=O1Sswmcb_uCGkmIf\&q=85\&s=31113458f21f0530c64c0defa5837384)

# Zoom

## Connection

### Setup

Build a Server-to-Server OAuth app for Klef in the [Zoom App Marketplace](https://marketplace.zoom.us/), signed in as an admin who can manage users. Zoom's [guide](https://developers.zoom.us/docs/internal-apps/create/) walks through building one.

**Step 1**

In the Marketplace, choose **Develop**, then **Build App**, and pick **Server to Server OAuth App**.

**Step 2**

Under **Scopes**, add:

* **Users:** `user:read:list_users:admin`, `user:read:user:admin`, `user:write:user:admin`, `user:update:user:admin`, `user:update:status:admin`, and `user:delete:user:admin`
* **Roles:** `role:read:list_roles:admin`, `role:write:member:admin`, and `role:delete:member:admin`
* **Groups:** `group:read:list_groups:admin`, `group:read:list_members:admin`, `group:write:member:admin`, `group:delete:member:admin`, `group:read:administrator:admin`, `group:write:administrator:admin`, and `group:delete:administrator:admin`

**Step 3**

Activate the app, then copy its **Account ID**, **Client ID**, and **Client secret** into Klef.

### Settings

| Setting | Required | Description |
| - | - | - |
| Account ID | Yes | Account ID of your Server-to-Server OAuth app. |
| Client ID | Yes | Client ID of your Server-to-Server OAuth app. |
| Client secret | Yes | Client secret of your Server-to-Server OAuth app. |

## zoom.user

### Fields

| Field | Type | Required | Description |
| - | - | - | - |
| `email` | string | Yes | Email address the user signs in with, where Zoom sends the confirmation. The connector does not change it once the user exists. Never changed once the account exists. |
| `firstName` | string, up to 64 | | First name. |
| `lastName` | string, up to 64 | | Last name. |
| `displayName` | string, up to 128 | | Name other people see in meetings. Zoom makes one from the first and last name when this is left out. |
| `department` | string, up to 128 | | Department. |
| `license` | enum | | The user's license type. Defaults to basic. A licensed user takes one of the account's paid seats. Values: `basic` (Basic), `licensed` (Licensed), `unassigned` (Unassigned without Meetings Basic). |
| `role` | string | | Role ID. The Member role takes the user out of any other role, and Zoom never assigns the Owner role this way. |
| `groups` | entitlements | | Groups the user belongs to. One row grants one group. |
| `groups[]` | string | | Group ID. |
| `adminGroups` | entitlements | | Groups the user administers. One row grants one group. |
| `adminGroups[]` | string | | Group ID. |
| `active` | bool | | Whether the user can sign in. The connector deactivates a user it removes, which keeps their meetings and recordings, and withdraws a user who never confirmed. Shows the account's status: a policy reads it and sets `status` instead. |
| `deleted` | bool | | Whether to delete the user, with their meetings, webinars, and recordings unless they go to a recipient. |
| `transferTo` | string | | Email of the user who receives the deleted user's meetings, webinars, and recordings. They must belong to the account. |
| `status` | enum | | Whether the person can sign in, the account is kept switched off, or the account is gone. Values: `enabled` (Enabled), `disabled` (Disabled). |

### Default Account Matching Rules

When Klef [adopts](https://klef.ai/docs/adoption.md) an account that already exists in Zoom, it works out whose it is by trying these in order. A connection can override them.

| Account field | Worker field |
| - | - |
| `email` | `worker.business_email` |

## Examples

### Zoom users

A basic Zoom user for every employee, deactivated with their recordings kept when they leave.

```hcl theme={null}
stage active {
  target zoom.user {
    email      = worker.business_email
    firstName  = worker.legal_name.given
    lastName   = worker.legal_name.family
    department = worker.department.name
    license    = "basic"
    status     = enabled
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.