Skip to content

Commit

Permalink
Format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorGFM committed Mar 21, 2024
1 parent e0df24a commit 751264e
Show file tree
Hide file tree
Showing 63 changed files with 1,042 additions and 1,042 deletions.
12 changes: 6 additions & 6 deletions docs/data-sources/access_token_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ output "token_length" {

### Read-Only

- `default_validity` (String) The default duration used for access token validity. Defaults to `36000s`. Should follow the protobuf duration string format, which corresponds to a sequence of decimal numbers suffixed by a 's' at the end, representing the duration in seconds. For example: `300s`, `60s`, `10.50s`, etc.
- `id` (String) The data source identifier. It's set as `settings/access_token`.
- `max_number_of_tokens_per_user` (Number) The maximum number of access tokens that a user can have at the same time. Must be between `1` and `5` (inclusive). Defaults to `3`.
- `max_validity` (String) The maximum duration that a user can request for access token validity. Defaults to `36000s`. Should follow the protobuf duration string format, which corresponds to a sequence of decimal numbers suffixed by a 's' at the end, representing the duration in seconds. For example: `300s`, `60s`, `10.50s`, etc.
- `offline_token_validation` (Boolean) The configuration that determines if the sidecar should perform access token validation independently using cached token values. If this is `true`, the sidecar will be able to validate and authenticate database access even when it cannot reach the Control Plane. Defaults to `true`.
- `token_length` (Number) The number of characters of the access token plaintext value. Valid values are `8`, `12` and `16`. Defaults to `16`.
- `default_validity` (String) The default duration used for access token validity. Defaults to `36000s`. Should follow the protobuf duration string format, which corresponds to a sequence of decimal numbers suffixed by a 's' at the end, representing the duration in seconds. For example: `300s`, `60s`, `10.50s`, etc.
- `id` (String) The data source identifier. It's set as `settings/access_token`.
- `max_number_of_tokens_per_user` (Number) The maximum number of access tokens that a user can have at the same time. Must be between `1` and `5` (inclusive). Defaults to `3`.
- `max_validity` (String) The maximum duration that a user can request for access token validity. Defaults to `36000s`. Should follow the protobuf duration string format, which corresponds to a sequence of decimal numbers suffixed by a 's' at the end, representing the duration in seconds. For example: `300s`, `60s`, `10.50s`, etc.
- `offline_token_validation` (Boolean) The configuration that determines if the sidecar should perform access token validation independently using cached token values. If this is `true`, the sidecar will be able to validate and authenticate database access even when it cannot reach the Control Plane. Defaults to `true`.
- `token_length` (Number) The number of characters of the access token plaintext value. Valid values are `8`, `12` and `16`. Defaults to `16`.
34 changes: 17 additions & 17 deletions docs/data-sources/datalabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "cyral_datalabel Data Source - terraform-provider-cyral"
subcategory: ""
description: |-
Retrieve and filter data labels. See also resource cyral_datalabel ../resources/datalabel.md.
Retrieve and filter data labels. See also resource cyral_datalabel ../resources/datalabel.md.
---

# cyral_datalabel (Data Source)
Expand All @@ -27,36 +27,36 @@ data "cyral_datalabel" "some_data_source_name" {

### Optional

- `name` (String) Retrieve the unique label with this name, if it exists.
- `type` (String) Filter the results by type of data label. Defaults to `UNKNOWN`, which will return all label types. The labels you create will always have type `CUSTOM`. Labels that come pre-configured in the control plane have type `PREDEFINED`. List of supported types:
- `UNKNOWN`
- `PREDEFINED`
- `CUSTOM`
- `name` (String) Retrieve the unique label with this name, if it exists.
- `type` (String) Filter the results by type of data label. Defaults to `UNKNOWN`, which will return all label types. The labels you create will always have type `CUSTOM`. Labels that come pre-configured in the control plane have type `PREDEFINED`. List of supported types:
- `UNKNOWN`
- `PREDEFINED`
- `CUSTOM`

### Read-Only

- `datalabel_list` (List of Object) List of existing data labels satisfying the filter criteria. (see [below for nested schema](#nestedatt--datalabel_list))
- `id` (String) The ID of this resource.
- `datalabel_list` (List of Object) List of existing data labels satisfying the filter criteria. (see [below for nested schema](#nestedatt--datalabel_list))
- `id` (String) The ID of this resource.

<a id="nestedatt--datalabel_list"></a>

### Nested Schema for `datalabel_list`

Read-Only:

- `classification_rule` (Set of Object) (see [below for nested schema](#nestedobjatt--datalabel_list--classification_rule))
- `description` (String)
- `implicit` (Boolean)
- `name` (String)
- `tags` (List of String)
- `type` (String)
- `classification_rule` (Set of Object) (see [below for nested schema](#nestedobjatt--datalabel_list--classification_rule))
- `description` (String)
- `implicit` (Boolean)
- `name` (String)
- `tags` (List of String)
- `type` (String)

<a id="nestedobjatt--datalabel_list--classification_rule"></a>

### Nested Schema for `datalabel_list.classification_rule`

Read-Only:

- `rule_code` (String)
- `rule_status` (String)
- `rule_type` (String)
- `rule_code` (String)
- `rule_status` (String)
- `rule_type` (String)
18 changes: 9 additions & 9 deletions docs/data-sources/integration_idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "cyral_integration_idp Data Source - terraform-provider-cyral"
subcategory: ""
description: |-
~> DEPRECATED Use resource and data source cyral_integration_idp_saml instead.
~> DEPRECATED Use resource and data source cyral_integration_idp_saml instead.
---

# cyral_integration_idp (Data Source)
Expand All @@ -16,21 +16,21 @@ description: |-

### Optional

- `display_name` (String) Filter results by the name of an existing IdP integration.
- `type` (String) Filter results by the IdP integration type.
- `display_name` (String) Filter results by the name of an existing IdP integration.
- `type` (String) Filter results by the IdP integration type.

### Read-Only

- `id` (String) The ID of this resource.
- `idp_list` (List of Object) List of existing IdP integrations for the given filter criteria. (see [below for nested schema](#nestedatt--idp_list))
- `id` (String) The ID of this resource.
- `idp_list` (List of Object) List of existing IdP integrations for the given filter criteria. (see [below for nested schema](#nestedatt--idp_list))

<a id="nestedatt--idp_list"></a>

### Nested Schema for `idp_list`

Read-Only:

- `alias` (String)
- `display_name` (String)
- `enabled` (Boolean)
- `single_sign_on_service_url` (String)
- `alias` (String)
- `display_name` (String)
- `enabled` (Boolean)
- `single_sign_on_service_url` (String)
54 changes: 27 additions & 27 deletions docs/data-sources/integration_idp_saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "cyral_integration_idp_saml Data Source - terraform-provider-cyral"
subcategory: ""
description: |-
Retrieve and filter SAML IdP integrations.
Retrieve and filter SAML IdP integrations.
---

# cyral_integration_idp_saml (Data Source)
Expand All @@ -26,67 +26,67 @@ data "cyral_integration_idp_saml" "some_data_source_name" {

### Optional

- `display_name` (String) Filter results by the display name (as seen in the control plane UI) of existing SAML IdP integrations.
- `idp_type` (String) Filter results by the SAML IdP integration type.
- `display_name` (String) Filter results by the display name (as seen in the control plane UI) of existing SAML IdP integrations.
- `idp_type` (String) Filter results by the SAML IdP integration type.

### Read-Only

- `id` (String) The ID of this resource.
- `idp_list` (List of Object) List of existing SAML IdP integrations that match the given filter criteria. (see [below for nested schema](#nestedatt--idp_list))
- `id` (String) The ID of this resource.
- `idp_list` (List of Object) List of existing SAML IdP integrations that match the given filter criteria. (see [below for nested schema](#nestedatt--idp_list))

<a id="nestedatt--idp_list"></a>

### Nested Schema for `idp_list`

Read-Only:

- `attributes` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--attributes))
- `disabled` (Boolean)
- `display_name` (String)
- `id` (String)
- `idp_descriptor` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--idp_descriptor))
- `idp_type` (String)
- `sp_metadata` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--sp_metadata))
- `attributes` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--attributes))
- `disabled` (Boolean)
- `display_name` (String)
- `id` (String)
- `idp_descriptor` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--idp_descriptor))
- `idp_type` (String)
- `sp_metadata` (Set of Object) (see [below for nested schema](#nestedobjatt--idp_list--sp_metadata))

<a id="nestedobjatt--idp_list--attributes"></a>

### Nested Schema for `idp_list.attributes`

Read-Only:

- `email` (String)
- `first_name` (String)
- `groups` (String)
- `last_name` (String)
- `email` (String)
- `first_name` (String)
- `groups` (String)
- `last_name` (String)

<a id="nestedobjatt--idp_list--idp_descriptor"></a>

### Nested Schema for `idp_list.idp_descriptor`

Read-Only:

- `disable_force_authentication` (Boolean)
- `signing_certificate` (String)
- `single_logout_service_url` (String)
- `single_sign_on_service_url` (String)
- `disable_force_authentication` (Boolean)
- `signing_certificate` (String)
- `single_logout_service_url` (String)
- `single_sign_on_service_url` (String)

<a id="nestedobjatt--idp_list--sp_metadata"></a>

### Nested Schema for `idp_list.sp_metadata`

Read-Only:

- `assertion_consumer_services` (List of Object) (see [below for nested schema](#nestedobjatt--idp_list--sp_metadata--assertion_consumer_services))
- `entity_id` (String)
- `single_logout_url` (String)
- `url` (String)
- `xml_document` (String)
- `assertion_consumer_services` (List of Object) (see [below for nested schema](#nestedobjatt--idp_list--sp_metadata--assertion_consumer_services))
- `entity_id` (String)
- `single_logout_url` (String)
- `url` (String)
- `xml_document` (String)

<a id="nestedobjatt--idp_list--sp_metadata--assertion_consumer_services"></a>

### Nested Schema for `idp_list.sp_metadata.assertion_consumer_services`

Read-Only:

- `index` (Number)
- `url` (String)
- `index` (Number)
- `url` (String)
58 changes: 29 additions & 29 deletions docs/data-sources/integration_logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,91 +22,91 @@ data "cyral_integration_logging" "another_data_source_name" {

### Optional

- `type` (String) The type of logging integration config to filter by.
- `type` (String) The type of logging integration config to filter by.

### Read-Only

- `id` (String) The ID of this resource.
- `integrations` (List of Object) List of existing integration configs for the given filter criteria. (see [below for nested schema](#nestedatt--integrations))
- `id` (String) The ID of this resource.
- `integrations` (List of Object) List of existing integration configs for the given filter criteria. (see [below for nested schema](#nestedatt--integrations))

<a id="nestedatt--integrations"></a>

### Nested Schema for `integrations`

Read-Only:

- `cloudwatch` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--cloudwatch))
- `datadog` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--datadog))
- `elk` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--elk))
- `fluent_bit` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--fluent_bit))
- `id` (String)
- `name` (String)
- `receive_audit_logs` (Boolean)
- `splunk` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--splunk))
- `sumo_logic` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--sumo_logic))
- `cloudwatch` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--cloudwatch))
- `datadog` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--datadog))
- `elk` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--elk))
- `fluent_bit` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--fluent_bit))
- `id` (String)
- `name` (String)
- `receive_audit_logs` (Boolean)
- `splunk` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--splunk))
- `sumo_logic` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--sumo_logic))

<a id="nestedobjatt--integrations--cloudwatch"></a>

### Nested Schema for `integrations.cloudwatch`

Read-Only:

- `group` (String)
- `region` (String)
- `stream` (String)
- `group` (String)
- `region` (String)
- `stream` (String)

<a id="nestedobjatt--integrations--datadog"></a>

### Nested Schema for `integrations.datadog`

Read-Only:

- `api_key` (String)
- `api_key` (String)

<a id="nestedobjatt--integrations--elk"></a>

### Nested Schema for `integrations.elk`

Read-Only:

- `es_credentials` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--elk--es_credentials))
- `es_url` (String)
- `kibana_url` (String)
- `es_credentials` (Set of Object) (see [below for nested schema](#nestedobjatt--integrations--elk--es_credentials))
- `es_url` (String)
- `kibana_url` (String)

<a id="nestedobjatt--integrations--elk--es_credentials"></a>

### Nested Schema for `integrations.elk.es_credentials`

Read-Only:

- `password` (String)
- `username` (String)
- `password` (String)
- `username` (String)

<a id="nestedobjatt--integrations--fluent_bit"></a>

### Nested Schema for `integrations.fluent_bit`

Read-Only:

- `config` (String)
- `skip_validate` (Boolean)
- `config` (String)
- `skip_validate` (Boolean)

<a id="nestedobjatt--integrations--splunk"></a>

### Nested Schema for `integrations.splunk`

Read-Only:

- `access_token` (String)
- `hec_port` (String)
- `hostname` (String)
- `index` (String)
- `use_tls` (Boolean)
- `access_token` (String)
- `hec_port` (String)
- `hostname` (String)
- `index` (String)
- `use_tls` (Boolean)

<a id="nestedobjatt--integrations--sumo_logic"></a>

### Nested Schema for `integrations.sumo_logic`

Read-Only:

- `address` (String)
- `address` (String)
12 changes: 6 additions & 6 deletions docs/data-sources/permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "cyral_permission Data Source - terraform-provider-cyral"
subcategory: ""
description: |-
Retrieve all Cyral permissions. See also resource cyral_service_account ../resources/service_account.md.
Retrieve all Cyral permissions. See also resource cyral_service_account ../resources/service_account.md.
---

# cyral_permission (Data Source)
Expand All @@ -16,15 +16,15 @@ Retrieve all Cyral permissions. See also resource [`cyral_service_account`](../r

### Read-Only

- `id` (String) The data source identifier.
- `permission_list` (List of Object) List of all existing Cyral permissions. (see [below for nested schema](#nestedatt--permission_list))
- `id` (String) The data source identifier.
- `permission_list` (List of Object) List of all existing Cyral permissions. (see [below for nested schema](#nestedatt--permission_list))

<a id="nestedatt--permission_list"></a>

### Nested Schema for `permission_list`

Read-Only:

- `description` (String)
- `id` (String)
- `name` (String)
- `description` (String)
- `id` (String)
- `name` (String)
Loading

0 comments on commit 751264e

Please sign in to comment.