~> Deprecation Notice Equinix Metal will reach end of life on June 30, 2026. All Metal resources will be removed in version 5.0.0 of this provider. Use version 4.x of this provider for continued use through sunset. See https://docs.equinix.com/metal/ for more information.

equinix_metal_organization_member (Resource)

Manage the membership of existing and new invitees within an Equinix Metal organization and its projects.

Example Usage

Add a member to an organization to collaborate on given projects:

resource "equinix_metal_organization_member" "member" {
    invitee = "member@example.com"
    roles = ["limited_collaborator"]
    projects_ids = [var.project_id]
    organization_id = var.organization_id
}

Add a member to an organization as an organization administrator:

resource "equinix_metal_organization_member" "owner" {
    invitee = "admin@example.com"
    roles = ["owner"]
    projects_ids = []
    organization_id = var.organization_id
}

Argument Reference

The following arguments are supported:

• invitee - (Required) The email address of the user to invite
• organization_id - (Required) The organization to invite the user to
• projects_ids - (Required) Project IDs the member has access to within the organization. If the member is an 'admin', the projects list should be empty.
• roles - (Required) Organization roles (admin, collaborator, limited_collaborator, billing)
• message - A message to include in the emailed invitation.

Attribute Reference

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

• id - The unique ID of the membership.
• nonce - The nonce for the invitation (only known in the invitation stage)
• invited_by - The user_id of the user that sent the invitation (only known in the invitation stage)
• created - When the invitation was created (only known in the invitation stage)
• updated - When the invitation was updated (only known in the invitation stage)
• state - The state of the membership ('invited' when an invitation is open, 'active' when the user is an organization member)

Import

This resource can be imported using the invitee and organization_id as colon separated arguments:

terraform import equinix_metal_organization_member.resource_name {invitee}:{organization_id}