Update openapi.json; bump version to 0.4.1; speakeasy run

.speakeasy/gen.yaml

@@ -12,7 +12,7 @@ generation:
  auth:
  oAuth2ClientCredentialsEnabled: true
 terraform:
- version: 0.3.8
+ version: 0.4.1
  additionalDataSources: []
  additionalDependencies: {}
  additionalResources: []

.speakeasy/workflow.lock

@@ -1,18 +1,17 @@
-speakeasyVersion: 1.349.1
+speakeasyVersion: 1.398.1
 sources:
  FastAPI:
  sourceNamespace: fast-api
- sourceRevisionDigest: sha256:8658fde83b1400f5e3db7d0ac154023835df2825052cefbacb15e274f9ffe4b5
- sourceBlobDigest: sha256:00a3332cca11ca58a96c63d25b6fe0c42bc727827fe108718e9dfecc7247a359
+ sourceRevisionDigest: sha256:51780857332f7af5fca36f766869e4361bb4842cd6adf0150e7550499f99889d
+ sourceBlobDigest: sha256:a6c98bbff601430c4c39dbfdaabe5f0a96df21d37be349c37af43c4221d791b1
  tags:
  - latest
 targets:
  lumos-terraform-provider-target:
  source: FastAPI
  sourceNamespace: fast-api
- sourceRevisionDigest: sha256:8658fde83b1400f5e3db7d0ac154023835df2825052cefbacb15e274f9ffe4b5
- sourceBlobDigest: sha256:00a3332cca11ca58a96c63d25b6fe0c42bc727827fe108718e9dfecc7247a359
- outLocation: /Users/niamh/terraform-provider-lumos
+ sourceRevisionDigest: sha256:51780857332f7af5fca36f766869e4361bb4842cd6adf0150e7550499f99889d
+ sourceBlobDigest: sha256:a6c98bbff601430c4c39dbfdaabe5f0a96df21d37be349c37af43c4221d791b1
 workflow:
  workflowVersion: 1.0.0
  speakeasyVersion: latest

README.md

@@ -6,8 +6,8 @@
 
 <no value>
 
-<!-- Start SDK Installation [installation] -->
-## SDK Installation
+<!-- Start Installation [installation] -->
+## Installation
 
 To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
 
@@ -16,7 +16,7 @@ terraform {
  required_providers {
  lumos = {
  source = "teamlumos/lumos"
- version = "0.3.8"
+ version = "0.4.1"
  }
  }
 }
@@ -25,19 +25,17 @@ provider "lumos" {
  # Configuration options
 }
 ```
-<!-- End SDK Installation [installation] -->
+<!-- End Installation [installation] -->
 
-<!-- Start SDK Example Usage [usage] -->
-## SDK Example Usage
+<!-- Start Testing the provider locally [usage] -->
+## Testing the provider locally
 
-### Testing the provider locally
+#### Local Provider
 
 Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.
 
 This also allows for debuggers (e.g. delve) to be attached to the provider.
 
-### Example
-
 ```sh
 go run main.go --debug
 # Copy the TF_REATTACH_PROVIDERS env var
@@ -46,13 +44,67 @@ cd examples/your-example
 TF_REATTACH_PROVIDERS=... terraform init
 TF_REATTACH_PROVIDERS=... terraform apply
 ```
-<!-- End SDK Example Usage [usage] -->
 
-<!-- Start Available Resources and Operations [operations] -->
-## Available Resources and Operations
+#### Compiled Provider
+
+Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.
+
+1. Execute `go build` to construct a binary called `terraform-provider-lumos`
+2. Ensure that the `.terraformrc` file is configured with a `dev_overrides` section such that your local copy of terraform can see the provider binary
+
+Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.
+
+```
+provider_installation {
 
+ dev_overrides {
+ "registry.terraform.io/teamlumos/lumos" = "<PATH>"
+ }
 
-<!-- End Available Resources and Operations [operations] -->
+ # For all other providers, install them directly from their origin provider
+ # registries as normal. If you omit this, Terraform will _only_ use
+ # the dev_overrides block, and so no other providers will be available.
+ direct {}
+}
+```
+<!-- End Testing the provider locally [usage] -->
+
+<!-- Start Available Resources and Data Sources [operations] -->
+## Available Resources and Data Sources
+
+### Resources
+
+* [lumos_app](docs/resources/app.md)
+* [lumos_app_store_app](docs/resources/app_store_app.md)
+* [lumos_pre_approval_rule](docs/resources/pre_approval_rule.md)
+* [lumos_requestable_permission](docs/resources/requestable_permission.md)
+### Data Sources
+
+* [lumos_app](docs/data-sources/app.md)
+* [lumos_apps](docs/data-sources/apps.md)
+* [lumos_app_store_app](docs/data-sources/app_store_app.md)
+* [lumos_app_store_app_settings](docs/data-sources/app_store_app_settings.md)
+* [lumos_group](docs/data-sources/group.md)
+* [lumos_groups](docs/data-sources/groups.md)
+* [lumos_requestable_permission](docs/data-sources/requestable_permission.md)
+* [lumos_requestable_permissions](docs/data-sources/requestable_permissions.md)
+* [lumos_user](docs/data-sources/user.md)
+* [lumos_users](docs/data-sources/users.md)
+<!-- End Available Resources and Data Sources [operations] -->
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Lumos: The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [Installation](#installation)
+* [Available Resources and Data Sources](#available-resources-and-data-sources)
+* [Testing the provider locally](#testing-the-provider-locally)
+<!-- End Table of Contents [toc] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 

docs/data-sources/app.md

@@ -14,7 +14,7 @@ App DataSource
 
 ```terraform
 data "lumos_app" "my_app" {
- id = "9232d259-b0ac-4589-917f-afa4f89362b5"
+ id = "...my_id..."
 }
 ```
 
@@ -30,6 +30,6 @@ data "lumos_app" "my_app" {
 - `logo_url` (String) The URL of the logo of this app.
 - `request_instructions` (String) The request instructions.
 - `sources` (List of String) The sources of this app.
-- `status` (String) An enumeration. must be one of ["DISCOVERED", "NEEDS_REVIEW", "APPROVED", "BLOCKLISTED", "DEPRECATED"]
+- `status` (String) The status of this app. Possible values: 'DISCOVERED', 'NEEDS_REVIEW', 'APPROVED', 'BLOCKLISTED', 'DEPRECATED'
 - `user_friendly_label` (String) The user-friendly label of this app.
 - `website_url` (String) The URL of the website of this app.

docs/data-sources/app_store_app.md

@@ -34,6 +34,6 @@ data "lumos_app_store_app" "my_appstoreapp" {
 - `logo_url` (String) The URL of the logo of this app.
 - `request_instructions` (String) The request instructions.
 - `sources` (List of String) The sources of this app.
-- `status` (String) An enumeration. must be one of ["DISCOVERED", "NEEDS_REVIEW", "APPROVED", "BLOCKLISTED", "DEPRECATED"]
+- `status` (String) The status of this app. Possible values: 'DISCOVERED', 'NEEDS_REVIEW', 'APPROVED', 'BLOCKLISTED', 'DEPRECATED'
 - `user_friendly_label` (String) The user-friendly label of this app.
 - `website_url` (String) The URL of the website of this app.

docs/data-sources/app_store_app_settings.md

@@ -14,7 +14,7 @@ AppStoreAppSettings DataSource
 
 ```terraform
 data "lumos_app_store_app_settings" "my_appstoreappsettings" {
- id = "2afd9232-720d-468f-846b-d9cdb3faf8ec"
+ id = "...my_id..."
 }
 ```
 
@@ -36,7 +36,7 @@ Read-Only:
 - `access_removal_inline_webhook` (Attributes) A deprovisioning webhook can be optionally associated with this config. (see [below for nested schema](#nestedatt--provisioning--access_removal_inline_webhook))
 - `allow_multiple_permission_selection` (Boolean) Whether the app is configured to allow users to request multiple permissions in a single request
 - `custom_provisioning_instructions` (String) Only Available if manual steps is active. During the provisioning step, Lumos will send a custom message to app admins explaining how to provision a user to the app. Markdown for links and text formatting is supported.
-- `groups_provisioning` (String) An enumeration. must be one of ["DIRECT_TO_USER", "GROUPS_AND_HIDDEN", "GROUPS_AND_VISIBLE"]
+- `groups_provisioning` (String) If enabled, Approvers must choose a group to provision the user to for access requests.
 - `manual_steps_needed` (Boolean) If enabled, Lumos will notify the App Admin after initial access is granted to perform additional manual steps. Note that if this option is enabled, this action must be confirmed by the App Admin in order to resolve the request.
 - `provisioning_webhook` (Attributes) The provisioning webhook optionally associated with this config. (see [below for nested schema](#nestedatt--provisioning--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.
@@ -47,7 +47,7 @@ Read-Only:
 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"]
+- `hook_type` (String) The type of this inline webhook.
 - `id` (String) The ID of this inline webhook.
 - `name` (String) The name of this inline webhook.
 
@@ -58,7 +58,7 @@ Read-Only:
 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"]
+- `hook_type` (String) The type of this inline webhook.
 - `id` (String) The ID of this inline webhook.
 - `name` (String) The name of this inline webhook.
 
@@ -74,7 +74,7 @@ Read-Only:
 - `approvers` (Attributes) AppStore App approvers assigned. (see [below for nested schema](#nestedatt--request_flow--approvers))
 - `approvers_stage_2` (Attributes) AppStore App stage 2 approvers assigned. (see [below for nested schema](#nestedatt--request_flow--approvers_stage_2))
 - `custom_approval_message` (String) After the approval step, send a custom message to requesters. Markdown for links and text formatting is supported.
-- `discoverability` (String) An enumeration. must be one of ["FULL", "LIMITED", "NONE"]
+- `discoverability` (String) AppStore App visibility.
 - `request_validation_inline_webhook` (Attributes) A request validation webhook can be optionally associated with this config. (see [below for nested schema](#nestedatt--request_flow--request_validation_inline_webhook))
 - `require_additional_approval` (Boolean) Only turn on when working with sensitive permissions to ensure a smooth employee experience.
 - `require_manager_approval` (Boolean) When a user makes an access request, require that their manager approves the request before moving on to additional approvals.
@@ -94,7 +94,7 @@ 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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.
@@ -110,7 +110,7 @@ Read-Only:
 - `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"]
+- `status` (String) The status of this user.
 
 
 
@@ -120,7 +120,7 @@ Read-Only:
 Read-Only:
 
 - `groups` (Attributes Set) The groups allowed to request this permission. (see [below for nested schema](#nestedatt--request_flow--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"]
+- `type` (String) The type of this allowed groups config, can be all groups or specific.
 
 <a id="nestedatt--request_flow--allowed_groups--groups"></a>
 ### Nested Schema for `request_flow.allowed_groups.groups`
@@ -129,7 +129,7 @@ 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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.
@@ -152,7 +152,7 @@ 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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.
@@ -168,7 +168,7 @@ Read-Only:
 - `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"]
+- `status` (String) The status of this user.
 
 
 
@@ -187,7 +187,7 @@ 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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.
@@ -203,7 +203,7 @@ Read-Only:
 - `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"]
+- `status` (String) The status of this user.
 
 
 
@@ -213,6 +213,6 @@ Read-Only:
 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"]
+- `hook_type` (String) The type of this inline webhook.
 - `id` (String) The ID of this inline webhook.
 - `name` (String) The name of this inline webhook.

docs/data-sources/apps.md

@@ -14,10 +14,10 @@ Apps DataSource
 
 ```terraform
 data "lumos_apps" "my_apps" {
- exact_match = false
+ exact_match = true
  name_search = "...my_name_search..."
- page = 1
- size = 6
+ page = 3
+ size = 19
 }
 ```
 
@@ -28,8 +28,8 @@ data "lumos_apps" "my_apps" {
 
 - `exact_match` (Boolean) Search filter should be an exact match.
 - `name_search` (String) Search against name, app instance identifier, and app class ID.
-- `page` (Number)
-- `size` (Number)
+- `page` (Number) Page number
+- `size` (Number) Page size
 
 ### Read-Only
 
@@ -49,6 +49,6 @@ Read-Only:
 - `logo_url` (String) The URL of the logo of this app.
 - `request_instructions` (String) The request instructions.
 - `sources` (List of String) The sources of this app.
-- `status` (String) An enumeration. must be one of ["DISCOVERED", "NEEDS_REVIEW", "APPROVED", "BLOCKLISTED", "DEPRECATED"]
+- `status` (String) The status of this app. Possible values: 'DISCOVERED', 'NEEDS_REVIEW', 'APPROVED', 'BLOCKLISTED', 'DEPRECATED'
 - `user_friendly_label` (String) The user-friendly label of this app.
 - `website_url` (String) The URL of the website of this app.

docs/data-sources/group.md

@@ -29,7 +29,7 @@ data "lumos_group" "my_group" {
 
 - `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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.

docs/data-sources/groups.md

@@ -15,11 +15,11 @@ Groups DataSource
 ```terraform
 data "lumos_groups" "my_groups" {
  app_id = "...my_app_id..."
- exact_match = true
+ exact_match = false
  integration_specific_id = "...my_integration_specific_id..."
- name = "Wendy Bergnaum"
- page = 4
- size = 7
+ name = "...my_name..."
+ page = 1
+ size = 2
 }
 ```
 
@@ -32,8 +32,8 @@ data "lumos_groups" "my_groups" {
 - `exact_match` (Boolean) Search filter should be an exact match.
 - `integration_specific_id` (String) Filters groups by integration specific ID, e.g. the group's Okta ID.
 - `name` (String) Filters groups by name.
-- `page` (Number)
-- `size` (Number)
+- `page` (Number) Page number
+- `size` (Number) Page size
 
 ### Read-Only
 
@@ -48,7 +48,7 @@ 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"]
+- `group_lifecycle` (String) The lifecycle of this group.
 - `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.