Terraform Zoom Provider

This terraform provider allows to perform Create ,Read ,Update, Delete, Import and Deactivate Zoom User(s).

Requirements

• Go 1.16
  
• Terraform 0.13.x
  
• Zoom Pro/Premium account

Zoom Setup

❗ [IMPORTANT] : This provider can only be successfully tested on a premium paid zoom account.

1. Create a zoom account with paid subscription (PRO Plan/Business Account). (https://zoom.us/)
   
2. Sign in to the zoom account.
   
3. Go to Zoom Marketplace
   
4. Click on Build App. For our purpose we need to make a JWT App.
   
5. Follow this Create JWT Zoom App website to make an app.
   This app will provide us with the API Secret, API Key, and token which will be needed to configure our provider and make request.
   

Initialise Zoom Provider in local machine

1. Clone the repository to $GOPATH/src/github.com/zoom/terraform-provider-zoom
   
2. Add the API Secret, API Key generated in the JWT Zoom App to respective fields in main.tf
   
3. Run the following command :

go mod init terraform-provider-zoom
go mod tidy

4. Run go mod vendor to create a vendor directory that contains all the provider's dependencies.
   

Managing plugins for terraform

1. Run the following command to create a vendor subdirectory which will comprise of all provider dependencies.
   

~/.terraform.d/plugins/${host_name}/${namespace}/${type}/${version}/${target}

Command:

mkdir -p ~/.terraform.d/plugins/hashicorp.com/edu/zoom/0.2.0/[OS_ARCH]

For eg. mkdir -p ~/.terraform.d/plugins/hashicorp.com/edu/zoom/0.2.0/windows_amd64

2. Run go build -o terraform-provider-zoom.exe. This will save the binary (.exe) file in the main/root directory.
   
3. Run this command to move this binary file to appropriate location.

move terraform-provider-zoom.exe %APPDATA%\terraform.d\plugins\hashicorp.com\edu\zoom\0.2.0\[OS_ARCH]

Otherwise you can manually move the file from current directory to destination directory.

[OR]

1. Download required binaries
   
2. move binary ~/.terraform.d/plugins/[architecture name]/

Working with terraform

Create User

1. Add the user email, first name, last name, status, license_type,deartment,job_title,location in the respective field in main.tf
2. set API_SECRET and API_KEY.
3. Initialize the terraform provider terraform init
4. Check the changes applicable using terraform plan and apply using terraform apply
5. You will see that a user has been successfully created and an account activation mail has been sent to the user.
6. Activate the account using the link provided in the mail.

Update the user

Update the data of the user in the main.tf file and apply using terraform apply

Read the User Data

Add data and output blocks in the main.tf file and run terraform plan to read user data

Activate/Deactivate the user

Change the status of User from activate to deactivate or viceversa anf run terraform apply.

Delete the user

Delete the resource block of the particular user from main.tf file and run terraform apply.

Import a User Data

1. Write manually a resource configuration block for the User in main.tf, to which the imported object will be mapped.
2. Run the command terraform import zoom_user.user1 [EMAIL_ID]
3. Check for the attributes in the .tfstate file and fill them accordingly in resource block.

Testing the Provider

1. Navigate to the test file directory.
2. Run command go test . This command will give combined test result for the execution or errors if any failure occur.
3. If you want to see test result of each test function individually while running test in a single go, run command go test -v
4. To check test cover run go test -cover

Example Usage

terraform {
  required_providers {
    zoom = {
      version = "0.2"
      source  = "hashicorp.com/edu/zoom"
    }
  }
}

provider "zoom" {
  apikey = ""
  apisecret = ""
}

resource "zoom_user" "user1" {
   email      = "[EMAIL_ID]"
   first_name = "[USER_FIRST_NAME]"
   last_name  = "[USER_LAST_NAME]"
   status = "activate"
   license_type = [INTEGER VALUE]
   department = "[USER_DEPARTMENT]"
   job_title = "[USER_JOB_TITLE]"
   location   =  "[USER_LOCATION]"
}

data "zoom_user" "user1" {
  id = "[EMAIL_ID]"
}

output "user1" {
  value = data.zoom_user.user1
}

Argument Reference

• apikey(Required,string) - The Zoom API Key
• apisecret(Required,string) - The Zoom API Secret
• email(Required,string) - The email id associated with the user account.
• first_name(Required,string) - First name of the User.
• last_name(Required,string) - Last Name / Family Name / Surname of the User.
• status(Optional,string) - User account activation status ie.(activate,deactivate).
• license_type(Required,integer) - User account type ie.(1=Basic, 2=License, 3=On-prem)
• job_title(Optional,string) - Job title of the particular user.
• department(Optional,string) - Department of the particular user.
• location(Optional,string) - Department of the particular user.
• id(Computed,string) - Unique ID of the User which is same as Email ID.
• pmi(Computed,integer) - Generated pmi no of the user.
• role_name(Computed,string) - Current role of the user ie.(Admin,Member).