Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

080352d · Aug 13, 2024

History

History
63 lines (49 loc) · 1.72 KB

File metadata and controls

63 lines (49 loc) · 1.72 KB
page_title subcategory description
coderd_user Resource - terraform-provider-coderd
A user on the Coder deployment.

coderd_user (Resource)

A user on the Coder deployment.

Example Usage

// Provider populated from environemnt variables
provider "coderd" {}

// Create a bot user for Jenkins
resource "coderd_user" "jenkins" {
  username   = "jenkins"
  name       = "Jenkins CI/CD"
  email      = "ci@example.com"
  roles      = ["template-admin"]
  login_type = "none"
}

// Keep the password of a user account up to date from an external source
resource "coderd_user" "audit" {
  username   = "auditor"
  name       = "Auditor"
  email      = "security@example.com"
  roles      = ["auditor"]
  login_type = "password"
  password   = data.vault_password.auditor.value
}

// Ensure the admin account is suspended
resource "coderd_user" "admin" {
  username  = "admin"
  suspended = true
}

Schema

Required

  • email (String) Email address of the user.
  • username (String) Username of the user.

Optional

  • login_type (String) Type of login for the user. Valid types are 'none', 'password', 'github', and 'oidc'.
  • name (String) Display name of the user. Defaults to username.
  • password (String, Sensitive) Password for the user. Required when login_type is 'password'. Passwords are saved into the state as plain text and should only be used for testing purposes.
  • roles (Set of String) Roles assigned to the user. Valid roles are 'owner', 'template-admin', 'user-admin', and 'auditor'.
  • suspended (Boolean) Whether the user is suspended.

Read-Only

  • id (String) User ID