organization_membership.html.markdown

layout	page_title	sidebar_current	description
tfe	Terraform Enterprise: tfe_organization_membership	docs-resource-tfe-organization-membership	Add or remove a user from an organization.

tfe_organization_membership

Add or remove a user from an organization.

~> NOTE: This resource requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202004-1.

~> NOTE: This resource cannot be used to update an existing user's email address since users themselves are the only ones permitted to update their email address. If a user updates their email address, configurations using the email address should be updated manually.

Example Usage

Basic usage:

resource "tfe_organization_membership" "test" {
  organization  = "my-org-name"
  email = "user@company.com"
}

Argument Reference

The following arguments are supported:

• organization - (Required) Name of the organization.
• email - (Required) Email of the user to add.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - The organization membership ID.
• user_id - The ID of the user associated with the organization membership.
• username - The username of the user associated with the organization membership.

Organization memberships can be imported; use <ORGANIZATION MEMBERSHIP ID> as the import ID. For example:

terraform import tfe_organization_membership.test ou-wAs3zYmWAhYK7peR