Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nmanoogian committed Aug 14, 2024
1 parent c176784 commit b20456d
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/resources/group_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ description: |-

Manage a Doppler user/group membership.

**Note:** You can also exclusively manage all memberships in a group with a single resource.
See the `doppler_group_members` resource for more information.

## Example Usage

```terraform
Expand Down
62 changes: 62 additions & 0 deletions docs/resources/group_members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
page_title: "doppler_group_members Resource - terraform-provider-doppler"
subcategory: ""
description: |-
Manage a Doppler group's memberships.
---

# doppler_group_members (Resource)

Manage a Doppler group's memberships.

**Note:** The `doppler_group_members` resource will clear/replace all existing memberships.
Multiple `doppler_group_members` resources or combinations of `doppler_group_members` and `doppler_group_member` will produce inconsistent behavior.
To non-exclusively manage group memberships, use `doppler_group_member` only.

## Example Usage

```terraform
resource "doppler_group" "engineering" {
name = "engineering"
}
data "doppler_user" "nic" {
email = "[email protected]"
}
data "doppler_user" "andre" {
email = "[email protected]"
}
resource "doppler_group_members" "engineering" {
group_slug = doppler_group.engineering.slug
user_slugs = [
data.doppler_user.nic.slug,
data.doppler_user.andre.slug
]
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `group_slug` (String) The slug of the group
- `user_slugs` (Set of String) A list of user slugs in the group

### Read-Only

- `id` (String) The ID of this resource.

## Import

Import is supported using the following syntax:

```shell
# import using the group slug from the URL:
# https://dashboard.doppler.com/workplace/[workplace-slug]/team/groups/[group-slug]
# and the user slugs from the URL:
# https://dashboard.doppler.com/workplace/[workplace-slug]/team/users/[user-slug]
terraform import doppler_group_members.default <group-slug>
```

0 comments on commit b20456d

Please sign in to comment.