Skip to content

AD Group Membership with Terraform»

Manage AD Group Membership in Microsoft Active Directory using the KopiCloud AD API Terraform Provider

Resources»

Add an AD User to an AD Group»

Terraform KopiCloud_AD_API

Add an AD User to an AD Group:

1
2
3
4
resource "kopicloud_group_membership" "test" {
  user_name  = "guillermo"
  group_name = "KopiCloud Architects"
}

Returns the Group Membership of an AD User:

1
2
3
4
output "OUTPUT_kopicloud_group_membership" {
  description = "Added User to an AD Group"
  value       = resource.kopicloud_group_membership.test
}

Schema

Required:

  • user_name (String) AD Username

Optional:

  • group_name (String) AD Group Name

Read-Only:

  • id (String) The ID of this Resource

  • result (List of Objects) Single AD Group (see below for nested schema)

Add an AD Group to an AD Group»

Terraform KopiCloud_AD_API

Add an AD Group to an AD Group:

1
2
3
4
resource "kopicloud_group_membership" "test" {
  parent_group_name = "KopiCloud DevOps"
  child_group_name  = "KopiCloud Architects"
}

Returns the Group Membership of the AD Group:

1
2
3
4
output "OUTPUT_kopicloud_group_membership" {
  description = "Added User to an AD Group"
  value       = resource.kopicloud_group_membership.test
}

Schema

Required:

  • parent_group_name (String) Parent AD Group Name

  • child_group_name (String) Child AD Group Name

Read-Only:

  • id (String) The ID of this Resource

  • result (List of Objects) Single AD Group (see below for nested schema)

Data Sources»

List Group Membership of AD User»

Terraform KopiCloud_AD_API

List AD User Group Membership:

1
2
3
data "kopicloud_group_membership_list" "test" {
  user_name  = "guillermo"
}

Show Group Membership:

1
2
3
4
output "OUTPUT_active_directory_user_list_all" {
  description = "Return all AD User Group Membership"
  value = data.kopicloud_active_directory_user_list.all
}

Schema

Required:

  • user_name (String) AD Username

Optional:

  • group_name (String) AD Group Name

Read-Only:

  • id (String) The ID of this Resource

  • result (List of Objects) Single AD Group (see below for nested schema)

Nested Schema for Result:»

Read-Only:

  • description (String) AD Group Description

  • email (String) AD Group Email Address

  • guid (String) AD Group GUID

  • name (String) AD Group Name

  • ou_path (String) AD Group OU Path (Distinguished Name)

  • scope (String) AD Group Scope

  • type (String) AD Group Type

List Group Membership of AD Group»

Terraform KopiCloud_AD_API

List AD User Group Membership:

1
2
3
data "kopicloud_group_membership_list" "test" {
  group_name  = "KopiCloud DevOps"
}

Show Group Membership:

1
2
3
4
output "OUTPUT_active_directory_user_list_all" {
  description = "Return all AD User Group Membership"
  value = data.kopicloud_active_directory_user_list.all
}

Schema

Required:

  • group_name (String) AD Group Name

Read-Only:

  • id (String) The ID of this Resource

  • result (List of Objects) Single AD Group (see below for nested schema)

Nested Schema for Result:»

Read-Only:

  • description (String) AD Group Description

  • email (String) AD Group Email Address

  • guid (String) AD Group GUID

  • name (String) AD Group Name

  • ou_path (String) AD Group OU Path (Distinguished Name)

  • scope (String) AD Group Scope

  • type (String) AD Group Type

Notes»

Running this resource with terraform apply `` will add or modify an AD user's group membership, and runningterraform destroy `` will remove the AD User from the AD Group.

Source Code»

Source code available here