-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
245 changed files
with
1,373 additions
and
302 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,237 @@ | ||
--- | ||
# generated by https:/hashicorp/terraform-plugin-docs | ||
page_title: "lumos_requestable_permissions Data Source - terraform-provider-lumos" | ||
subcategory: "" | ||
description: |- | ||
RequestablePermissions DataSource | ||
--- | ||
|
||
# lumos_requestable_permissions (Data Source) | ||
|
||
RequestablePermissions DataSource | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "lumos_requestable_permissions" "my_requestablepermissions" { | ||
app_id = "...my_app_id..." | ||
exact_match = true | ||
in_app_store = false | ||
page = 7 | ||
search_term = "...my_search_term..." | ||
size = 10 | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `app_id` (String) Filters requestable permissions by the ID of the app to which they belong. | ||
- `exact_match` (Boolean) Search filter should be an exact match. | ||
- `in_app_store` (Boolean) Filters permissions by visibility in the AppStore. | ||
- `page` (Number) | ||
- `search_term` (String) Searches permissions by the permission's group name, | ||
request configuration name, or specific integration ID. | ||
- `size` (Number) | ||
|
||
### Read-Only | ||
|
||
- `items` (Attributes List) (see [below for nested schema](#nestedatt--items)) | ||
- `pages` (Number) | ||
- `total` (Number) | ||
|
||
<a id="nestedatt--items"></a> | ||
### Nested Schema for `items` | ||
|
||
Read-Only: | ||
|
||
- `app_class_id` (String) The non-unique ID of the service associated with this requestable permission. Depending on how it is sourced in Lumos, this may be the app's name, website, or other identifier. | ||
- `app_id` (String) The ID of the app associated with this requestable permission. | ||
- `app_instance_id` (String) The ID of the instance associated with this requestable permission. | ||
- `id` (String) The ID of this requestable permission. | ||
- `label` (String) The label of this requestable permission. | ||
- `request_config` (Attributes) The request config associated with this requestable permission. (see [below for nested schema](#nestedatt--items--request_config)) | ||
- `type` (String) The type of this requestable permission. must be one of ["SYNCED", "NATIVE"] | ||
|
||
<a id="nestedatt--items--request_config"></a> | ||
### Nested Schema for `items.request_config` | ||
|
||
Read-Only: | ||
|
||
- `access_removal_inline_webhook` (Attributes) A deprovisioning webhook can be optionally associated with this config. (see [below for nested schema](#nestedatt--items--request_config--access_removal_inline_webhook)) | ||
- `allowed_groups` (Attributes) The allowed groups config associated with this config. (see [below for nested schema](#nestedatt--items--request_config--allowed_groups)) | ||
- `allowed_groups_override` (Boolean) Indicates if allowed groups is overriden from the app-level settings. | ||
- `appstore_visibility` (String) The appstore visibility of this request config. must be one of ["HIDDEN", "VISIBLE"] | ||
- `request_approval_config` (Attributes) A request approval config can be optionally associated with this config (see [below for nested schema](#nestedatt--items--request_config--request_approval_config)) | ||
- `request_fulfillment_config` (Attributes) A request fulfillment config can be optionally associated with this config (see [below for nested schema](#nestedatt--items--request_config--request_fulfillment_config)) | ||
- `request_validation_inline_webhook` (Attributes) A request validation webhook can be optionally associated with this config. (see [below for nested schema](#nestedatt--items--request_config--request_validation_inline_webhook)) | ||
|
||
<a id="nestedatt--items--request_config--access_removal_inline_webhook"></a> | ||
### Nested Schema for `items.request_config.access_removal_inline_webhook` | ||
|
||
Read-Only: | ||
|
||
- `description` (String) The description of this inline webhook. | ||
- `hook_type` (String) An enumeration. must be one of ["PRE_APPROVAL", "PROVISION", "DEPROVISION", "REQUEST_VALIDATION", "SIEM"] | ||
- `id` (String) The ID of this inline webhook. | ||
- `name` (String) The name of this inline webhook. | ||
|
||
|
||
<a id="nestedatt--items--request_config--allowed_groups"></a> | ||
### Nested Schema for `items.request_config.allowed_groups` | ||
|
||
Read-Only: | ||
|
||
- `groups` (Attributes Set) The groups allowed to request this permission. (see [below for nested schema](#nestedatt--items--request_config--allowed_groups--groups)) | ||
- `type` (String) The type of this allowed groups config, can be all groups or specific. must be one of ["ALL_GROUPS", "SPECIFIED_GROUPS"] | ||
|
||
<a id="nestedatt--items--request_config--allowed_groups--groups"></a> | ||
### Nested Schema for `items.request_config.allowed_groups.type` | ||
|
||
Read-Only: | ||
|
||
- `app_id` (String) The ID of the app that sources this group. | ||
- `description` (String) The description of this group. | ||
- `group_lifecycle` (String) The lifecycle of this group. must be one of ["SYNCED", "NATIVE"] | ||
- `id` (String) The ID of this group. | ||
- `integration_specific_id` (String) The ID of this group, specific to the integration. | ||
- `name` (String) The name of this group. | ||
- `source_app_id` (String) The ID of the app that sources this group. | ||
|
||
|
||
|
||
<a id="nestedatt--items--request_config--request_approval_config"></a> | ||
### Nested Schema for `items.request_config.request_approval_config` | ||
|
||
Read-Only: | ||
|
||
- `approvers` (Attributes) AppStore App approvers assigned. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--approvers)) | ||
- `approvers_stage_2` (Attributes) AppStore App stage 2 approvers assigned. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--approvers_stage_2)) | ||
- `custom_approval_message` (String) After the approval step, send a custom message to requesters. Note that the permission level approval message will override the App level approval message if custom_approval_message_override is set. Markdown for links and text formatting is supported. | ||
- `custom_approval_message_override` (Boolean) Indicates if custom_approval_message is overridden. | ||
- `manager_approval` (String) Manager approval can be configured as necessary to continue. must be one of ["NONE", "INITIAL_APPROVAL"] | ||
- `request_approval_config_override` (Boolean) Indicates if approval flow is overridden. | ||
- `require_additional_approval` (Boolean) Only turn on when working with sensitive permissions to ensure a smooth employee experience. | ||
|
||
<a id="nestedatt--items--request_config--request_approval_config--approvers"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval` | ||
|
||
Read-Only: | ||
|
||
- `groups` (Attributes Set) Groups assigned as support request approvers. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--require_additional_approval--groups)) | ||
- `users` (Attributes Set) Users assigned as support request approvers. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--require_additional_approval--users)) | ||
|
||
<a id="nestedatt--items--request_config--request_approval_config--require_additional_approval--groups"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval.groups` | ||
|
||
Read-Only: | ||
|
||
- `app_id` (String) The ID of the app that sources this group. | ||
- `description` (String) The description of this group. | ||
- `group_lifecycle` (String) The lifecycle of this group. must be one of ["SYNCED", "NATIVE"] | ||
- `id` (String) The ID of this group. | ||
- `integration_specific_id` (String) The ID of this group, specific to the integration. | ||
- `name` (String) The name of this group. | ||
- `source_app_id` (String) The ID of the app that sources this group. | ||
|
||
|
||
<a id="nestedatt--items--request_config--request_approval_config--require_additional_approval--users"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval.users` | ||
|
||
Read-Only: | ||
|
||
- `email` (String) The email of this user. | ||
- `family_name` (String) The family name of this user. | ||
- `given_name` (String) The given name of this user. | ||
- `id` (String) The ID of this user. | ||
- `status` (String) An enumeration. must be one of ["STAGED", "ACTIVE", "SUSPENDED", "INACTIVE"] | ||
|
||
|
||
|
||
<a id="nestedatt--items--request_config--request_approval_config--approvers_stage_2"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval` | ||
|
||
Read-Only: | ||
|
||
- `groups` (Attributes Set) Groups assigned as support request approvers. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--require_additional_approval--groups)) | ||
- `users` (Attributes Set) Users assigned as support request approvers. (see [below for nested schema](#nestedatt--items--request_config--request_approval_config--require_additional_approval--users)) | ||
|
||
<a id="nestedatt--items--request_config--request_approval_config--require_additional_approval--groups"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval.groups` | ||
|
||
Read-Only: | ||
|
||
- `app_id` (String) The ID of the app that sources this group. | ||
- `description` (String) The description of this group. | ||
- `group_lifecycle` (String) The lifecycle of this group. must be one of ["SYNCED", "NATIVE"] | ||
- `id` (String) The ID of this group. | ||
- `integration_specific_id` (String) The ID of this group, specific to the integration. | ||
- `name` (String) The name of this group. | ||
- `source_app_id` (String) The ID of the app that sources this group. | ||
|
||
|
||
<a id="nestedatt--items--request_config--request_approval_config--require_additional_approval--users"></a> | ||
### Nested Schema for `items.request_config.request_approval_config.require_additional_approval.users` | ||
|
||
Read-Only: | ||
|
||
- `email` (String) The email of this user. | ||
- `family_name` (String) The family name of this user. | ||
- `given_name` (String) The given name of this user. | ||
- `id` (String) The ID of this user. | ||
- `status` (String) An enumeration. must be one of ["STAGED", "ACTIVE", "SUSPENDED", "INACTIVE"] | ||
|
||
|
||
|
||
|
||
<a id="nestedatt--items--request_config--request_fulfillment_config"></a> | ||
### Nested Schema for `items.request_config.request_fulfillment_config` | ||
|
||
Read-Only: | ||
|
||
- `manual_instructions` (String) The manual instructions that go along. | ||
- `manual_steps_needed` (Boolean) Whether manual steps are needed. | ||
- `provisioning_group` (Attributes) The provisioning group optionally assocated with this config. (see [below for nested schema](#nestedatt--items--request_config--request_fulfillment_config--provisioning_group)) | ||
- `provisioning_webhook` (Attributes) The provisioning webhook optionally associated with this config. (see [below for nested schema](#nestedatt--items--request_config--request_fulfillment_config--provisioning_webhook)) | ||
- `time_based_access` (List of String) If enabled, users can request an app for a selected duration. After expiry, Lumos will automatically remove user's access. | ||
- `time_based_access_override` (Boolean) Indicates if time based access is overriden. | ||
|
||
<a id="nestedatt--items--request_config--request_fulfillment_config--provisioning_group"></a> | ||
### Nested Schema for `items.request_config.request_fulfillment_config.time_based_access_override` | ||
|
||
Read-Only: | ||
|
||
- `app_id` (String) The ID of the app that sources this group. | ||
- `description` (String) The description of this group. | ||
- `group_lifecycle` (String) The lifecycle of this group. must be one of ["SYNCED", "NATIVE"] | ||
- `id` (String) The ID of this group. | ||
- `integration_specific_id` (String) The ID of this group, specific to the integration. | ||
- `name` (String) The name of this group. | ||
- `source_app_id` (String) The ID of the app that sources this group. | ||
|
||
|
||
<a id="nestedatt--items--request_config--request_fulfillment_config--provisioning_webhook"></a> | ||
### Nested Schema for `items.request_config.request_fulfillment_config.time_based_access_override` | ||
|
||
Read-Only: | ||
|
||
- `description` (String) The description of this inline webhook. | ||
- `hook_type` (String) An enumeration. must be one of ["PRE_APPROVAL", "PROVISION", "DEPROVISION", "REQUEST_VALIDATION", "SIEM"] | ||
- `id` (String) The ID of this inline webhook. | ||
- `name` (String) The name of this inline webhook. | ||
|
||
|
||
|
||
<a id="nestedatt--items--request_config--request_validation_inline_webhook"></a> | ||
### Nested Schema for `items.request_config.request_validation_inline_webhook` | ||
|
||
Read-Only: | ||
|
||
- `description` (String) The description of this inline webhook. | ||
- `hook_type` (String) An enumeration. must be one of ["PRE_APPROVAL", "PROVISION", "DEPROVISION", "REQUEST_VALIDATION", "SIEM"] | ||
- `id` (String) The ID of this inline webhook. | ||
- `name` (String) The name of this inline webhook. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
examples/data-sources/lumos_requestable_permissions/data-source.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
data "lumos_requestable_permissions" "my_requestablepermissions" { | ||
app_id = "...my_app_id..." | ||
exact_match = true | ||
in_app_store = false | ||
page = 7 | ||
search_term = "...my_search_term..." | ||
size = 10 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
data "lumos_users" "my_users" { | ||
exact_match = true | ||
page = 1 | ||
exact_match = false | ||
page = 4 | ||
search_term = "...my_search_term..." | ||
size = 7 | ||
size = 8 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.