Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kgibson-spotnana committed Mar 19, 2024
1 parent 19b03c8 commit fad8841
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/data-sources/group_lookup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "jumpcloud_group_lookup Data Source - terraform-provider-jumpcloud"
subcategory: ""
description: |-
---

# jumpcloud_group_lookup (Data Source)



## Example Usage

```terraform
data "jumpcloud_group_lookup" "this" {
name = "example"
limit = 5
}
```

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

### Required

- `name` (String) The name to filter on

### Optional

- `limit` (Number) The limit of results to return

### Read-Only

- `groups` (Attributes List) A list of Jumpcloud Groups (see [below for nested schema](#nestedatt--groups))

<a id="nestedatt--groups"></a>
### Nested Schema for `groups`

Read-Only:

- `description` (String)
- `id` (String) The ID of the Group
- `members` (Set of String) The members of the Group
- `name` (String) The Name of the Group
- `type` (String) Types can be user_group or system_group
4 changes: 4 additions & 0 deletions examples/data-sources/jumpcloud_group_lookup/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
data "jumpcloud_group_lookup" "this" {
name = "example"
limit = 5
}
4 changes: 4 additions & 0 deletions examples/jumpcloud/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ provider "jumpcloud" {
# Pulls all usergroups from the JumpCloud API
data "jumpcloud_usergroups" "all_usergroups" {}

data "jumpcloud_group_lookup" "group_lookup" {
name = "test"
limit = 1
}
# Pulls all apps from the JumpCloud API
data "jumpcloud_apps" "all_apps" {}

Expand Down

0 comments on commit fad8841

Please sign in to comment.