terraform-provider-jumpcloud

README

JumpCloud Terraform Provider

The JumpCloud Terraform Provider is an unofficial plugin for managing your JumpCloud tenant configuration through the Terraform tool.

---

📚 Documentation

• Provider - jumpcloud
• Resource - jumpcloud_ad
• Resource - jumpcloud_devicegroup
• Resource - jumpcloud_usergroup

Requirements

• Terraform
• A JumpCloud account

Installation

Terraform uses the Terraform Registry to download and install providers. To install thisprovider copy and paste the following code into your Terraform configuration

terraform {
    required_providers {
        jumpcloud = {
            source = "techjavelin/jumpcloud
            version = ">=1.0.0"
        }
    }
}

Then at the command line, run the following command

$ terraform init

🎻 Getting Started

Use of the JumpCloud Provider requires a JumpCloud API Key

Getting your API Key

1. As an Administrator or Command Runner, login to the JumpCloud Console
2. From any tag inside of the Admin Console, click your account profile icon in the top-right and select My API Key from the drop-down.
3. Copy the API Key and save it someplace safe.

Now that you've got your API key, it's time to configure the provider. It is recommended that you use a sensitive variable in your JumpCloud configuration to access the key and provide the value at runtime, so it is never hard-coded into your source code.

Add the following to your main terraform configuration file (usually main.tf)

var "jumpcloud_api_key" {
    description = "API Key to access JumpCloud v1, v2, and insights APIs"
    sensitive = true
}

You'll also want to update your provider configuration - this can be done at the main level at the module level if your terraform configuration is broken into modules

provider "jumpcloud" {
    jumpcloud_api_key = var.jumpcloud_api_key
}

To inject the value of the API key at runtime, simple run terraform with the value on the environment

$ TF_VAR_jumpcloud_api_key="<your api key>" terraform <command> [options]

Note, you do not need to provide your key for init, fmt, or validate commands, plan and apply both require it.

For example:

$ terraform init
$ terraform fmt
$ terraform validate
$ TF_VAR_jumpcloud_api_key="1234" terraform plan --out apply.tfplan
$ TF_VAR_jumpcloud_api_key="1234" terraform apply apply.tfplan

Rotating your API Key

Occasionally, you may want or need to rotate your API Key. Usually this is due to events such as someone who had access to the value of the API key moving on to a new job or being terminated, simple click the button in the dialog you went to above and update your local storage to reflect the new API key

---

👋 How you can Contribute

☕ Contributing as a Developer

TechJavelin OSS welcomes any and all contributions to help our projects continue to provide value to the open source community! Feel free to create a fork and submit a pull request with your proposed changes at any time!

🎁 Sponsorship

Official Github Sponsorships are Coming Soon -- in the meantime you can support with Buy Me A Coffee

🙇 Support & Feedback

We welcome any and all feedback on our projects! Drop in on the Tech Javelin Official Discord. Professional Services and support are available through our Official Website

🗈 Raise an Issue

If you have found a bug or if you have a feature request, please raise an issue on our issue tracker.

🔐 Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. Please report directly to oss@techjavelin.com