@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/resources/malicious_user_mitigation.md

@@ -0,0 +1,132 @@
+---
+page_title: "f5xc_malicious_user_mitigation Resource - terraform-provider-f5xc"
+subcategory: "Security"
+description: |-
+  [Category: Security] [Namespace: required] Manages malicious_user_mitigation creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
+---
+
+# f5xc_malicious_user_mitigation (Resource)
+
+[Category: Security] [Namespace: required] Manages malicious_user_mitigation creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Malicious User Mitigation API docs](https://docs.cloud.f5.com/docs-v2/api/malicious-user-mitigation) to learn more.
+
+## Example Usage
+
+```terraform
+# Malicious User Mitigation Resource Example
+# [Category: Security] [Namespace: required] Manages malicious_user_mitigation creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
+
+# Basic Malicious User Mitigation configuration
+resource "f5xc_malicious_user_mitigation" "example" {
+  name      = "example-malicious-user-mitigation"
+  namespace = "shared"
+
+  labels = {
+    environment = "production"
+    managed_by  = "terraform"
+  }
+
+  annotations = {
+    "owner" = "platform-team"
+  }
+
+  # Malicious User Mitigation configuration
+  # Detection rules
+  rules {
+    threat_level = "HIGH"
+    mitigation_action {
+      block {
+        body   = "Access denied"
+        status = "403"
+      }
+    }
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Malicious User Mitigation. Must be unique within the namespace
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Malicious User Mitigation will be created
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
+
+<a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
+
+### Spec Argument Reference
+
+<a id="mitigation-type"></a>&#x2022; [`mitigation_type`](#mitigation-type) - Optional Block<br>Malicious User Mitigation Settings. Settings that specify the actions to be taken when malicious users are determined to be at different threat levels. User's activity is monitored and continuously analyzed for malicious behavior. From this analysis, a threat-level is assigned to each user. The settings defined in malicious user mitigation specify what mitigation actions to take for user determined to be at different threat levels<br>See [Mitigation Type](#mitigation-type) below for details.
+
+<a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+---
+
+#### Mitigation Type
+
+A [`mitigation_type`](#mitigation-type) block supports the following:
+
+<a id="mitigation-type-rules"></a>&#x2022; [`rules`](#mitigation-type-rules) - Optional Block<br>Rules. Define the threat levels and the corresponding mitigation actions to be taken<br>See [Rules](#mitigation-type-rules) below.
+
+#### Mitigation Type Rules
+
+A [`rules`](#mitigation-type-rules) block (within [`mitigation_type`](#mitigation-type)) supports the following:
+
+<a id="mitigation-type-rules-mitigation-action"></a>&#x2022; [`mitigation_action`](#mitigation-type-rules-mitigation-action) - Optional Block<br>Malicious User Mitigation Action. Supported actions that can be taken to mitigate malicious activity from a user<br>See [Mitigation Action](#mitigation-type-rules-mitigation-action) below.
+
+<a id="mitigation-type-rules-threat-level"></a>&#x2022; [`threat_level`](#mitigation-type-rules-threat-level) - Optional Block<br>Malicious User Threat Level. Threat level estimated for each user based on the user's activity and reputation<br>See [Threat Level](#mitigation-type-rules-threat-level) below.
+
+#### Mitigation Type Rules Mitigation Action
+
+A [`mitigation_action`](#mitigation-type-rules-mitigation-action) block (within [`mitigation_type.rules`](#mitigation-type-rules)) supports the following:
+
+<a id="mitigation-type-rules-mitigation-action-block-temporarily"></a>&#x2022; [`block_temporarily`](#mitigation-type-rules-mitigation-action-block-temporarily) - Optional Block<br>Enable this option
+
+<a id="mitigation-type-rules-mitigation-action-captcha-challenge"></a>&#x2022; [`captcha_challenge`](#mitigation-type-rules-mitigation-action-captcha-challenge) - Optional Block<br>Enable this option
+
+<a id="mitigation-type-rules-mitigation-action-javascript-challenge"></a>&#x2022; [`javascript_challenge`](#mitigation-type-rules-mitigation-action-javascript-challenge) - Optional Block<br>Enable this option
+
+#### Mitigation Type Rules Threat Level
+
+A [`threat_level`](#mitigation-type-rules-threat-level) block (within [`mitigation_type.rules`](#mitigation-type-rules)) supports the following:
+
+<a id="mitigation-type-rules-threat-level-high"></a>&#x2022; [`high`](#mitigation-type-rules-threat-level-high) - Optional Block<br>Enable this option
+
+<a id="mitigation-type-rules-threat-level-low"></a>&#x2022; [`low`](#mitigation-type-rules-threat-level-low) - Optional Block<br>Enable this option
+
+<a id="mitigation-type-rules-threat-level-medium"></a>&#x2022; [`medium`](#mitigation-type-rules-threat-level-medium) - Optional Block<br>Enable this option
+
+#### Timeouts
+
+A [`timeouts`](#timeouts) block supports the following:
+
+<a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
+
+<a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
+
+<a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
+
+<a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using namespace/name format
+terraform import f5xc_malicious_user_mitigation.example system/example
+```

package/dist/docs/resources/managed_tenant.md

@@ -0,0 +1,116 @@
+---
+page_title: "f5xc_managed_tenant Resource - terraform-provider-f5xc"
+subcategory: "Organization"
+description: |-
+  [Namespace: required] Manages managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage. in F5 Distributed Cloud.
+---
+
+# f5xc_managed_tenant (Resource)
+
+[Namespace: required] Manages managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Managed Tenant API docs](https://docs.cloud.f5.com/docs-v2/api/tenant-management-managed-tenant) to learn more.
+
+## Example Usage
+
+```terraform
+# Managed Tenant Resource Example
+# [Namespace: required] Manages managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage. in F5 Distributed Cloud.
+
+# Basic Managed Tenant configuration
+resource "f5xc_managed_tenant" "example" {
+  name      = "example-managed-tenant"
+  namespace = "staging"
+
+  labels = {
+    environment = "production"
+    managed_by  = "terraform"
+  }
+
+  annotations = {
+    "owner" = "platform-team"
+  }
+
+  # Resource-specific configuration
+  # Group Mapping. List of local user group association to us...
+  groups {
+    # Configure groups settings
+  }
+  # Object reference. This type establishes a direct referenc...
+  group {
+    # Configure group settings
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Managed Tenant. Must be unique within the namespace
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Managed Tenant will be created
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
+
+<a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
+
+### Spec Argument Reference
+
+<a id="groups"></a>&#x2022; [`groups`](#groups) - Optional Block<br>Group Mapping. List of local user group association to user groups in the managed tenant specified in the tenant_choice<br>See [Groups](#groups) below for details.
+
+<a id="tenant-id"></a>&#x2022; [`tenant_id`](#tenant-id) - Optional String<br>Managed Tenant ID. Specify the Tenant ID of the existing tenant which needs to be managed. User can select Tenant ID from dropdown if managed tenant has already configured delegated access or manually input the Tenant ID if managed tenant configuration will happen in future
+
+<a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+---
+
+#### Groups
+
+A [`groups`](#groups) block supports the following:
+
+<a id="groups-group"></a>&#x2022; [`group`](#groups-group) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Group](#groups-group) below.
+
+<a id="groups-managed-tenant-groups"></a>&#x2022; [`managed_tenant_groups`](#groups-managed-tenant-groups) - Optional List<br>Managed Tenant Groups. List of group names in managed tenant (MT). Note - To properly establish access, admin of managed tenant need to create corresponding Allowed Tenant configuration object with access to use same group names. Once it's setup, when user from original tenant access managed tenant, underlying roles from managed tenant will be applied to user
+
+#### Groups Group
+
+A [`group`](#groups-group) block (within [`groups`](#groups)) supports the following:
+
+<a id="groups-group-name"></a>&#x2022; [`name`](#groups-group-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="groups-group-namespace"></a>&#x2022; [`namespace`](#groups-group-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="groups-group-tenant"></a>&#x2022; [`tenant`](#groups-group-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+#### Timeouts
+
+A [`timeouts`](#timeouts) block supports the following:
+
+<a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
+
+<a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
+
+<a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
+
+<a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using namespace/name format
+terraform import f5xc_managed_tenant.example system/example
+```

package/dist/docs/resources/namespace.md

@@ -0,0 +1,87 @@
+---
+page_title: "f5xc_namespace Resource - terraform-provider-f5xc"
+subcategory: "Organization"
+description: |-
+  [Category: Organization] [Namespace: not_required] Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
+---
+
+# f5xc_namespace (Resource)
+
+[Category: Organization] [Namespace: not_required] Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Namespace API docs](https://docs.cloud.f5.com/docs-v2/api/namespace) to learn more.
+
+## Example Usage
+
+```terraform
+# Namespace Resource Example
+# [Category: Organization] [Namespace: not_required] Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
+
+# Basic Namespace configuration
+resource "f5xc_namespace" "example" {
+  name      = "example-namespace"
+  namespace = "system"
+
+  labels = {
+    environment = "production"
+    managed_by  = "terraform"
+  }
+
+  annotations = {
+    "owner" = "platform-team"
+  }
+
+  # Namespace configuration
+  description = "Example namespace for application workloads"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Namespace. Must be unique within the namespace
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
+
+<a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Optional String<br>Namespace for the Namespace. For this resource type, namespace should be empty or omitted
+
+### Spec Argument Reference
+
+<a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+---
+
+#### Timeouts
+
+A [`timeouts`](#timeouts) block supports the following:
+
+<a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
+
+<a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
+
+<a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
+
+<a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using namespace/name format
+terraform import f5xc_namespace.example system/example
+```