diff --git a/docs/data-sources/group_lookup.md b/docs/data-sources/group_lookup.md new file mode 100644 index 0000000..479c203 --- /dev/null +++ b/docs/data-sources/group_lookup.md @@ -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 + +### 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)) + + +### 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 diff --git a/examples/data-sources/jumpcloud_group_lookup/data-source.tf b/examples/data-sources/jumpcloud_group_lookup/data-source.tf new file mode 100644 index 0000000..be01da1 --- /dev/null +++ b/examples/data-sources/jumpcloud_group_lookup/data-source.tf @@ -0,0 +1,4 @@ +data "jumpcloud_group_lookup" "this" { + name = "example" + limit = 5 +} \ No newline at end of file diff --git a/examples/jumpcloud/main.tf b/examples/jumpcloud/main.tf index ee85d36..7ab4a32 100644 --- a/examples/jumpcloud/main.tf +++ b/examples/jumpcloud/main.tf @@ -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" {}