@robinmordasiewicz/f5xc-terraform-mcp 3.0.0 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/dist/docs/data-sources/addon_service.md +143 -0
  2. package/dist/docs/data-sources/addon_service_activation_status.md +144 -0
  3. package/dist/docs/data-sources/addon_subscription.md +134 -0
  4. package/dist/docs/data-sources/allowed_tenant.md +134 -0
  5. package/dist/docs/data-sources/api_credential.md +134 -0
  6. package/dist/docs/data-sources/bigip_irule.md +134 -0
  7. package/dist/docs/data-sources/child_tenant.md +134 -0
  8. package/dist/docs/data-sources/child_tenant_manager.md +134 -0
  9. package/dist/docs/data-sources/contact.md +134 -0
  10. package/dist/docs/data-sources/customer_support.md +134 -0
  11. package/dist/docs/data-sources/dns_lb_health_check.md +134 -0
  12. package/dist/docs/data-sources/dns_lb_pool.md +134 -0
  13. package/dist/docs/data-sources/dns_load_balancer.md +134 -0
  14. package/dist/docs/data-sources/dns_zone.md +145 -0
  15. package/dist/docs/data-sources/geo_location_set.md +134 -0
  16. package/dist/docs/data-sources/ike1.md +134 -0
  17. package/dist/docs/data-sources/ike2.md +134 -0
  18. package/dist/docs/data-sources/ike_phase1_profile.md +134 -0
  19. package/dist/docs/data-sources/ike_phase2_profile.md +134 -0
  20. package/dist/docs/data-sources/infraprotect_asn.md +134 -0
  21. package/dist/docs/data-sources/infraprotect_asn_prefix.md +134 -0
  22. package/dist/docs/data-sources/infraprotect_deny_list_rule.md +134 -0
  23. package/dist/docs/data-sources/infraprotect_firewall_rule.md +134 -0
  24. package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +134 -0
  25. package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +134 -0
  26. package/dist/docs/data-sources/infraprotect_tunnel.md +134 -0
  27. package/dist/docs/data-sources/k8s_cluster.md +134 -0
  28. package/dist/docs/data-sources/k8s_cluster_role.md +134 -0
  29. package/dist/docs/data-sources/k8s_cluster_role_binding.md +134 -0
  30. package/dist/docs/data-sources/k8s_pod_security_admission.md +134 -0
  31. package/dist/docs/data-sources/k8s_pod_security_policy.md +134 -0
  32. package/dist/docs/data-sources/managed_tenant.md +134 -0
  33. package/dist/docs/data-sources/namespace.md +141 -0
  34. package/dist/docs/data-sources/oidc_provider.md +134 -0
  35. package/dist/docs/data-sources/quota.md +134 -0
  36. package/dist/docs/data-sources/registration.md +134 -0
  37. package/dist/docs/data-sources/report_config.md +134 -0
  38. package/dist/docs/data-sources/role.md +134 -0
  39. package/dist/docs/data-sources/secret_policy.md +134 -0
  40. package/dist/docs/data-sources/secret_policy_rule.md +134 -0
  41. package/dist/docs/data-sources/securemesh_site_v2.md +134 -0
  42. package/dist/docs/data-sources/srv6_network_slice.md +134 -0
  43. package/dist/docs/data-sources/tenant_profile.md +134 -0
  44. package/dist/docs/data-sources/ticket_tracking_system.md +134 -0
  45. package/dist/docs/data-sources/token.md +134 -0
  46. package/dist/docs/data-sources/tpm_api_key.md +134 -0
  47. package/dist/docs/data-sources/tpm_category.md +134 -0
  48. package/dist/docs/data-sources/tpm_manager.md +134 -0
  49. package/dist/docs/data-sources/virtual_k8s.md +134 -0
  50. package/dist/docs/data-sources/voltshare_admin_policy.md +134 -0
  51. package/dist/docs/resources/addon_subscription.md +213 -0
  52. package/dist/docs/resources/allowed_tenant.md +181 -0
  53. package/dist/docs/resources/api_credential.md +184 -0
  54. package/dist/docs/resources/bigip_irule.md +173 -0
  55. package/dist/docs/resources/child_tenant.md +237 -0
  56. package/dist/docs/resources/child_tenant_manager.md +201 -0
  57. package/dist/docs/resources/contact.md +187 -0
  58. package/dist/docs/resources/customer_support.md +253 -0
  59. package/dist/docs/resources/dns_lb_health_check.md +249 -0
  60. package/dist/docs/resources/dns_lb_pool.md +310 -0
  61. package/dist/docs/resources/dns_load_balancer.md +309 -0
  62. package/dist/docs/resources/dns_zone.md +790 -0
  63. package/dist/docs/resources/geo_location_set.md +180 -0
  64. package/dist/docs/resources/ike1.md +216 -0
  65. package/dist/docs/resources/ike2.md +210 -0
  66. package/dist/docs/resources/ike_phase1_profile.md +224 -0
  67. package/dist/docs/resources/ike_phase2_profile.md +214 -0
  68. package/dist/docs/resources/infraprotect_asn.md +183 -0
  69. package/dist/docs/resources/infraprotect_asn_prefix.md +181 -0
  70. package/dist/docs/resources/infraprotect_deny_list_rule.md +191 -0
  71. package/dist/docs/resources/infraprotect_firewall_rule.md +288 -0
  72. package/dist/docs/resources/infraprotect_firewall_rule_group.md +169 -0
  73. package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +191 -0
  74. package/dist/docs/resources/infraprotect_tunnel.md +289 -0
  75. package/dist/docs/resources/k8s_cluster.md +326 -0
  76. package/dist/docs/resources/k8s_cluster_role.md +222 -0
  77. package/dist/docs/resources/k8s_cluster_role_binding.md +207 -0
  78. package/dist/docs/resources/k8s_pod_security_admission.md +199 -0
  79. package/dist/docs/resources/k8s_pod_security_policy.md +337 -0
  80. package/dist/docs/resources/managed_tenant.md +193 -0
  81. package/dist/docs/resources/namespace.md +170 -0
  82. package/dist/docs/resources/oidc_provider.md +291 -0
  83. package/dist/docs/resources/quota.md +187 -0
  84. package/dist/docs/resources/registration.md +489 -0
  85. package/dist/docs/resources/report_config.md +237 -0
  86. package/dist/docs/resources/role.md +183 -0
  87. package/dist/docs/resources/secret_policy.md +240 -0
  88. package/dist/docs/resources/secret_policy_rule.md +198 -0
  89. package/dist/docs/resources/securemesh_site_v2.md +2027 -0
  90. package/dist/docs/resources/srv6_network_slice.md +175 -0
  91. package/dist/docs/resources/tenant_profile.md +233 -0
  92. package/dist/docs/resources/ticket_tracking_system.md +195 -0
  93. package/dist/docs/resources/token.md +170 -0
  94. package/dist/docs/resources/tpm_api_key.md +191 -0
  95. package/dist/docs/resources/tpm_category.md +191 -0
  96. package/dist/docs/resources/tpm_manager.md +167 -0
  97. package/dist/docs/resources/virtual_k8s.md +209 -0
  98. package/dist/docs/resources/voltshare_admin_policy.md +271 -0
  99. package/package.json +1 -1
@@ -0,0 +1,170 @@
1
+ ---
2
+ page_title: "f5xc_namespace Resource - terraform-provider-f5xc"
3
+ subcategory: "Organization"
4
+ description: |-
5
+ Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
6
+ ---
7
+
8
+ # f5xc_namespace (Resource)
9
+
10
+ Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
11
+
12
+ ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
+
14
+ ## Example Usage
15
+
16
+ ```terraform
17
+ # Namespace Resource Example
18
+ # Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
19
+
20
+ # Basic Namespace configuration
21
+ resource "f5xc_namespace" "example" {
22
+ name = "example-namespace"
23
+ namespace = "system"
24
+
25
+ labels = {
26
+ environment = "production"
27
+ managed_by = "terraform"
28
+ }
29
+
30
+ annotations = {
31
+ "owner" = "platform-team"
32
+ }
33
+
34
+ # Namespace configuration
35
+ description = "Example namespace for application workloads"
36
+ }
37
+ ```
38
+
39
+ <!-- schema generated by tfplugindocs -->
40
+ ## Argument Reference
41
+
42
+ ### Metadata Argument Reference
43
+
44
+ <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Namespace. Must be unique within the namespace
45
+
46
+ <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
47
+
48
+ <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
49
+
50
+ <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
51
+
52
+ <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
53
+
54
+ <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Optional String<br>Namespace for the Namespace. For this resource type, namespace should be empty or omitted
55
+
56
+ ### Spec Argument Reference
57
+
58
+ <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
59
+
60
+ ### Attributes Reference
61
+
62
+ In addition to all arguments above, the following attributes are exported:
63
+
64
+ <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
65
+
66
+ ---
67
+
68
+ #### Timeouts
69
+
70
+ A [`timeouts`](#timeouts) block supports the following:
71
+
72
+ <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
73
+
74
+ <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
75
+
76
+ <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
77
+
78
+ <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
79
+
80
+ ---
81
+
82
+ ## Common Types
83
+
84
+ The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
85
+
86
+ ### Object Reference {#common-object-reference}
87
+
88
+ Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
89
+
90
+ | Field | Type | Description |
91
+ | ----- | ---- | ----------- |
92
+ | `name` | String | Name of the referenced object |
93
+ | `namespace` | String | Namespace containing the referenced object |
94
+ | `tenant` | String | Tenant of the referenced object (system-managed) |
95
+
96
+ ### Transformers {#common-transformers}
97
+
98
+ Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
99
+
100
+ | Value | Description |
101
+ | ----- | ----------- |
102
+ | `LOWER_CASE` | Convert to lowercase |
103
+ | `UPPER_CASE` | Convert to uppercase |
104
+ | `BASE64_DECODE` | Decode base64 content |
105
+ | `NORMALIZE_PATH` | Normalize URL path |
106
+ | `REMOVE_WHITESPACE` | Remove whitespace characters |
107
+ | `URL_DECODE` | Decode URL-encoded characters |
108
+ | `TRIM_LEFT` | Trim leading whitespace |
109
+ | `TRIM_RIGHT` | Trim trailing whitespace |
110
+ | `TRIM` | Trim both leading and trailing whitespace |
111
+
112
+ ### HTTP Methods {#common-http-methods}
113
+
114
+ HTTP methods used for request matching.
115
+
116
+ | Value | Description |
117
+ | ----- | ----------- |
118
+ | `ANY` | Match any HTTP method |
119
+ | `GET` | HTTP GET request |
120
+ | `HEAD` | HTTP HEAD request |
121
+ | `POST` | HTTP POST request |
122
+ | `PUT` | HTTP PUT request |
123
+ | `DELETE` | HTTP DELETE request |
124
+ | `CONNECT` | HTTP CONNECT request |
125
+ | `OPTIONS` | HTTP OPTIONS request |
126
+ | `TRACE` | HTTP TRACE request |
127
+ | `PATCH` | HTTP PATCH request |
128
+ | `COPY` | HTTP COPY request (WebDAV) |
129
+
130
+ ### TLS Fingerprints {#common-tls-fingerprints}
131
+
132
+ TLS fingerprint categories for malicious client detection.
133
+
134
+ | Value | Description |
135
+ | ----- | ----------- |
136
+ | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
137
+ | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
138
+ | `ADWARE` | Adware-associated fingerprints |
139
+ | `DRIDEX` | Dridex malware fingerprints |
140
+ | `GOOTKIT` | Gootkit malware fingerprints |
141
+ | `RANSOMWARE` | Ransomware-associated fingerprints |
142
+ | `TRICKBOT` | Trickbot malware fingerprints |
143
+
144
+ ### IP Threat Categories {#common-ip-threat-categories}
145
+
146
+ IP address threat categories for security filtering.
147
+
148
+ | Value | Description |
149
+ | ----- | ----------- |
150
+ | `SPAM_SOURCES` | Known spam sources |
151
+ | `WINDOWS_EXPLOITS` | Windows exploit sources |
152
+ | `WEB_ATTACKS` | Web attack sources |
153
+ | `BOTNETS` | Known botnet IPs |
154
+ | `SCANNERS` | Network scanner IPs |
155
+ | `REPUTATION` | Poor reputation IPs |
156
+ | `PHISHING` | Phishing-related IPs |
157
+ | `PROXY` | Anonymous proxy IPs |
158
+ | `MOBILE_THREATS` | Mobile threat sources |
159
+ | `TOR_PROXY` | Tor exit nodes |
160
+ | `DENIAL_OF_SERVICE` | DoS attack sources |
161
+ | `NETWORK` | Known bad network ranges |
162
+
163
+ ## Import
164
+
165
+ Import is supported using the following syntax:
166
+
167
+ ```shell
168
+ # Import using namespace/name format
169
+ terraform import f5xc_namespace.example system/example
170
+ ```
@@ -0,0 +1,291 @@
1
+ ---
2
+ page_title: "f5xc_oidc_provider Resource - terraform-provider-f5xc"
3
+ subcategory: "Authentication"
4
+ description: |-
5
+ Manages a OIDC Provider resource in F5 Distributed Cloud for customcreatespectype is the spec to create oidc provider configuration.
6
+ ---
7
+
8
+ # f5xc_oidc_provider (Resource)
9
+
10
+ Manages a OIDC Provider resource in F5 Distributed Cloud for customcreatespectype is the spec to create oidc provider configuration.
11
+
12
+ ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
+
14
+ ## Example Usage
15
+
16
+ ```terraform
17
+ # OIDC Provider Resource Example
18
+ # Manages a OIDC Provider resource in F5 Distributed Cloud for customcreatespectype is the spec to create oidc provider configuration.
19
+
20
+ # Basic OIDC Provider configuration
21
+ resource "f5xc_oidc_provider" "example" {
22
+ name = "example-oidc-provider"
23
+ namespace = "staging"
24
+
25
+ labels = {
26
+ environment = "production"
27
+ managed_by = "terraform"
28
+ }
29
+
30
+ annotations = {
31
+ "owner" = "platform-team"
32
+ }
33
+
34
+ # Resource-specific configuration
35
+ # [OneOf: azure_oidc_spec_type, google_oidc_spec_type, oidc...
36
+ azure_oidc_spec_type {
37
+ # Configure azure_oidc_spec_type settings
38
+ }
39
+ # Google OIDC Spec Type. GoogleOIDCSpecType specifies the a...
40
+ google_oidc_spec_type {
41
+ # Configure google_oidc_spec_type settings
42
+ }
43
+ # OpenID Connect v1.0 Spec Type. OIDCV10SpecType specifies ...
44
+ oidc_v10_spec_type {
45
+ # Configure oidc_v10_spec_type settings
46
+ }
47
+ }
48
+ ```
49
+
50
+ <!-- schema generated by tfplugindocs -->
51
+ ## Argument Reference
52
+
53
+ ### Metadata Argument Reference
54
+
55
+ <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the OIDC Provider. Must be unique within the namespace
56
+
57
+ <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the OIDC Provider will be created
58
+
59
+ <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
60
+
61
+ <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
62
+
63
+ <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
64
+
65
+ <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
66
+
67
+ ### Spec Argument Reference
68
+
69
+ -> **One of the following:**
70
+ &#x2022; <a id="azure-oidc-spec-type"></a>[`azure_oidc_spec_type`](#azure-oidc-spec-type) - Optional Block<br>Azure OIDC Spec Type. AzureOIDCSpecType specifies the attributes required to configure Azure provider<br>See [Azure OIDC Spec Type](#azure-oidc-spec-type) below for details.
71
+ <br><br>&#x2022; <a id="google-oidc-spec-type"></a>[`google_oidc_spec_type`](#google-oidc-spec-type) - Optional Block<br>Google OIDC Spec Type. GoogleOIDCSpecType specifies the attributes required to configure google provider<br>See [Google OIDC Spec Type](#google-oidc-spec-type) below for details.
72
+ <br><br>&#x2022; <a id="oidc-v10-spec-type"></a>[`oidc_v10_spec_type`](#oidc-v10-spec-type) - Optional Block<br>OpenID Connect v1.0 Spec Type. OIDCV10SpecType specifies the attributes required to configure OIDC provider<br>See [OIDC V10 Spec Type](#oidc-v10-spec-type) below for details.
73
+ <br><br>&#x2022; <a id="okta-oidc-spec-type"></a>[`okta_oidc_spec_type`](#okta-oidc-spec-type) - Optional Block<br>Okta OpenID Connect Spec Type. OKTAOIDCSpecType specifies the attributes required to configure okta OIDC provider<br>See [Okta OIDC Spec Type](#okta-oidc-spec-type) below for details.
74
+
75
+ <a id="provider-type"></a>&#x2022; [`provider_type`](#provider-type) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `GOOGLE`, `AZURE`, `OKTA`<br>[Enum: DEFAULT|GOOGLE|AZURE|OKTA] Provider Type. Types of OIDC providers Default provider. use this for standard OpenIDConnect v1.0 Authenticate with Google OIDC Authenticate with Azure OIDC Authenticate with Okta OIDC
76
+
77
+ <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
78
+
79
+ ### Attributes Reference
80
+
81
+ In addition to all arguments above, the following attributes are exported:
82
+
83
+ <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
84
+
85
+ ---
86
+
87
+ #### Azure OIDC Spec Type
88
+
89
+ An [`azure_oidc_spec_type`](#azure-oidc-spec-type) block supports the following:
90
+
91
+ <a id="azure-oidc-spec-type-authorization-url"></a>&#x2022; [`authorization_url`](#azure-oidc-spec-type-authorization-url) - Optional String<br>Authorization URL. The authorization URL of your OIDC application
92
+
93
+ <a id="azure-oidc-spec-type-backchannel-logout"></a>&#x2022; [`backchannel_logout`](#azure-oidc-spec-type-backchannel-logout) - Optional Bool<br>Backchannel Logout. Does the external IDP support backchannel logout?
94
+
95
+ <a id="azure-oidc-spec-type-client-id"></a>&#x2022; [`client_id`](#azure-oidc-spec-type-client-id) - Optional String<br>Client ID. Client ID of the OIDC application registered with azure provider. REQUIRED field
96
+
97
+ <a id="azure-oidc-spec-type-client-secret"></a>&#x2022; [`client_secret`](#azure-oidc-spec-type-client-secret) - Optional String<br>Client Secret. Secret of the OIDC application registered with azure provider
98
+
99
+ <a id="azure-oidc-spec-type-default-scopes"></a>&#x2022; [`default_scopes`](#azure-oidc-spec-type-default-scopes) - Optional String<br>Default Scopes. The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed
100
+
101
+ <a id="azure-oidc-spec-type-issuer"></a>&#x2022; [`issuer`](#azure-oidc-spec-type-issuer) - Optional String<br>Issuer. The issuer identifier for the issuer of the response. If not provided, no validation will be performed
102
+
103
+ <a id="azure-oidc-spec-type-jwks-url"></a>&#x2022; [`jwks_url`](#azure-oidc-spec-type-jwks-url) - Optional String<br>JWKS URL. URL where identity provider keys in JWK format are stored
104
+
105
+ <a id="azure-oidc-spec-type-logout-url"></a>&#x2022; [`logout_url`](#azure-oidc-spec-type-logout-url) - Optional String<br>Logout URL. Logout URL specified in your OIDC application
106
+
107
+ <a id="azure-oidc-spec-type-prompt"></a>&#x2022; [`prompt`](#azure-oidc-spec-type-prompt) - Optional String<br>Possible values are `UNSPECIFIED`, `NONE`, `CONSENT`, `LOGIN`, `SELECT_ACCOUNT`<br>[Enum: UNSPECIFIED|NONE|CONSENT|LOGIN|SELECT_ACCOUNT] Prompt Type. Type of prompt authorization server for end-user reauthentication and consent default value for no prompt. when this is set, no prompt parameter will be set on authorization request. The Authorization Server will not display any authentication or consent user interface page. The Authorization Server prompts the End-User for consent before returning information to the Client The Authorization Server prompts the End-User for reauthentication. The Authorization Server prompts the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for
108
+
109
+ <a id="azure-oidc-spec-type-token-url"></a>&#x2022; [`token_url`](#azure-oidc-spec-type-token-url) - Optional String<br>Token URL. The token URL of your OIDC application
110
+
111
+ <a id="azure-oidc-spec-type-user-info-url"></a>&#x2022; [`user_info_url`](#azure-oidc-spec-type-user-info-url) - Optional String<br>User Info URL. The User Info URL specified in your OIDC application
112
+
113
+ #### Google OIDC Spec Type
114
+
115
+ A [`google_oidc_spec_type`](#google-oidc-spec-type) block supports the following:
116
+
117
+ <a id="google-oidc-spec-type-client-id"></a>&#x2022; [`client_id`](#google-oidc-spec-type-client-id) - Optional String<br>Client ID. Client ID of the OIDC application registered with google provider. REQUIRED field
118
+
119
+ <a id="google-oidc-spec-type-client-secret"></a>&#x2022; [`client_secret`](#google-oidc-spec-type-client-secret) - Optional String<br>Client Secret. Secret of the OIDC application registered with google provider
120
+
121
+ <a id="google-oidc-spec-type-hosted-domain"></a>&#x2022; [`hosted_domain`](#google-oidc-spec-type-hosted-domain) - Optional String<br>Hosted Domain. set hosted domain to restrict user input on login form to use email address from this email domain. for example, setting value company.com will enforce user email input to have only `username@company.com` leave empty if no restriction is required for email address. ie for example allow `user@company1.com` and `user@company2.com`
122
+
123
+ #### OIDC V10 Spec Type
124
+
125
+ An [`oidc_v10_spec_type`](#oidc-v10-spec-type) block supports the following:
126
+
127
+ <a id="oidc-v10-spec-type-allowed-clock-skew"></a>&#x2022; [`allowed_clock_skew`](#oidc-v10-spec-type-allowed-clock-skew) - Optional String Defaults to `zero`<br>Allowed Clock Skew. Clock skew in seconds that is tolerated when validating identity provider tokens
128
+
129
+ <a id="oidc-v10-spec-type-authorization-url"></a>&#x2022; [`authorization_url`](#oidc-v10-spec-type-authorization-url) - Optional String<br>Authorization URL. The authorization URL of your OIDC application
130
+
131
+ <a id="oidc-v10-spec-type-backchannel-logout"></a>&#x2022; [`backchannel_logout`](#oidc-v10-spec-type-backchannel-logout) - Optional Bool<br>Backchannel Logout. Does the external IDP support backchannel logout?
132
+
133
+ <a id="oidc-v10-spec-type-client-id"></a>&#x2022; [`client_id`](#oidc-v10-spec-type-client-id) - Optional String<br>Client ID. Client ID of the OIDC application registered with your identity/OIDC provider
134
+
135
+ <a id="oidc-v10-spec-type-client-secret"></a>&#x2022; [`client_secret`](#oidc-v10-spec-type-client-secret) - Optional String<br>Client Secret. Secret of the OIDC application registered with your identity/OIDC provider
136
+
137
+ <a id="oidc-v10-spec-type-default-scopes"></a>&#x2022; [`default_scopes`](#oidc-v10-spec-type-default-scopes) - Optional String<br>Default Scopes. The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed
138
+
139
+ <a id="oidc-v10-spec-type-disable-user-info"></a>&#x2022; [`disable_user_info`](#oidc-v10-spec-type-disable-user-info) - Optional Bool<br>Disable User Info. Disable fetching of user info information
140
+
141
+ <a id="oidc-v10-spec-type-display-name"></a>&#x2022; [`display_name`](#oidc-v10-spec-type-display-name) - Optional String<br>Display Name. Friendly name for identity provider
142
+
143
+ <a id="parameters-902350"></a>&#x2022; [`forwarded_query_parameters`](#parameters-902350) - Optional String<br>Forwarded Query Parameters. Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request to Authorization Endpoint. Multiple parameters can be entered, separated by comma (,)
144
+
145
+ <a id="oidc-v10-spec-type-issuer"></a>&#x2022; [`issuer`](#oidc-v10-spec-type-issuer) - Optional String<br>Issuer. The issuer identifier for the issuer of the response. If not provided, no validation will be performed
146
+
147
+ <a id="oidc-v10-spec-type-jwks-url"></a>&#x2022; [`jwks_url`](#oidc-v10-spec-type-jwks-url) - Optional String<br>JWKS URL. URL where identity provider keys in JWK format are stored
148
+
149
+ <a id="oidc-v10-spec-type-logout-url"></a>&#x2022; [`logout_url`](#oidc-v10-spec-type-logout-url) - Optional String<br>Logout URL. Logout URL specified in your OIDC application
150
+
151
+ <a id="oidc-v10-spec-type-pass-current-locale"></a>&#x2022; [`pass_current_locale`](#oidc-v10-spec-type-pass-current-locale) - Optional Bool<br>Pass Current Locale. Pass the current locale to the identity provider
152
+
153
+ <a id="oidc-v10-spec-type-pass-login-hint"></a>&#x2022; [`pass_login_hint`](#oidc-v10-spec-type-pass-login-hint) - Optional Bool<br>Pass Login Hint. Pass login_hint to identity provider
154
+
155
+ <a id="oidc-v10-spec-type-prompt"></a>&#x2022; [`prompt`](#oidc-v10-spec-type-prompt) - Optional String<br>Possible values are `UNSPECIFIED`, `NONE`, `CONSENT`, `LOGIN`, `SELECT_ACCOUNT`<br>[Enum: UNSPECIFIED|NONE|CONSENT|LOGIN|SELECT_ACCOUNT] Prompt Type. Type of prompt authorization server for end-user reauthentication and consent default value for no prompt. when this is set, no prompt parameter will be set on authorization request. The Authorization Server will not display any authentication or consent user interface page. The Authorization Server prompts the End-User for consent before returning information to the Client The Authorization Server prompts the End-User for reauthentication. The Authorization Server prompts the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for
156
+
157
+ <a id="oidc-v10-spec-type-token-url"></a>&#x2022; [`token_url`](#oidc-v10-spec-type-token-url) - Optional String<br>Token URL. The token URL of your OIDC application
158
+
159
+ <a id="oidc-v10-spec-type-user-info-url"></a>&#x2022; [`user_info_url`](#oidc-v10-spec-type-user-info-url) - Optional String<br>User Info URL. The User Info URL specified in your OIDC application
160
+
161
+ <a id="oidc-v10-spec-type-validate-signatures"></a>&#x2022; [`validate_signatures`](#oidc-v10-spec-type-validate-signatures) - Optional Bool<br>Validate Signatures. Enable/disable signature validation of external IDP signatures
162
+
163
+ #### Okta OIDC Spec Type
164
+
165
+ An [`okta_oidc_spec_type`](#okta-oidc-spec-type) block supports the following:
166
+
167
+ <a id="okta-oidc-spec-type-authorization-url"></a>&#x2022; [`authorization_url`](#okta-oidc-spec-type-authorization-url) - Optional String<br>Authorization URL. The authorization URL of your OIDC application
168
+
169
+ <a id="okta-oidc-spec-type-backchannel-logout"></a>&#x2022; [`backchannel_logout`](#okta-oidc-spec-type-backchannel-logout) - Optional Bool<br>Backchannel Logout. Does the external IDP support backchannel logout?
170
+
171
+ <a id="okta-oidc-spec-type-client-id"></a>&#x2022; [`client_id`](#okta-oidc-spec-type-client-id) - Optional String<br>Client ID. Client ID of the OIDC application registered with azure provider
172
+
173
+ <a id="okta-oidc-spec-type-client-secret"></a>&#x2022; [`client_secret`](#okta-oidc-spec-type-client-secret) - Optional String<br>Client Secret. Secret of the OIDC application registered with azure provider
174
+
175
+ <a id="okta-oidc-spec-type-default-scopes"></a>&#x2022; [`default_scopes`](#okta-oidc-spec-type-default-scopes) - Optional String<br>Default Scopes. The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed
176
+
177
+ <a id="okta-oidc-spec-type-issuer"></a>&#x2022; [`issuer`](#okta-oidc-spec-type-issuer) - Optional String<br>Issuer. The issuer identifier for the issuer of the response. If not provided, no validation will be performed
178
+
179
+ <a id="okta-oidc-spec-type-jwks-url"></a>&#x2022; [`jwks_url`](#okta-oidc-spec-type-jwks-url) - Optional String<br>JWKS URL. URL where identity provider keys in JWK format are stored
180
+
181
+ <a id="okta-oidc-spec-type-logout-url"></a>&#x2022; [`logout_url`](#okta-oidc-spec-type-logout-url) - Optional String<br>Logout URL. Logout URL specified in your OIDC application
182
+
183
+ <a id="okta-oidc-spec-type-prompt"></a>&#x2022; [`prompt`](#okta-oidc-spec-type-prompt) - Optional String<br>Possible values are `UNSPECIFIED`, `NONE`, `CONSENT`, `LOGIN`, `SELECT_ACCOUNT`<br>[Enum: UNSPECIFIED|NONE|CONSENT|LOGIN|SELECT_ACCOUNT] Prompt Type. Type of prompt authorization server for end-user reauthentication and consent default value for no prompt. when this is set, no prompt parameter will be set on authorization request. The Authorization Server will not display any authentication or consent user interface page. The Authorization Server prompts the End-User for consent before returning information to the Client The Authorization Server prompts the End-User for reauthentication. The Authorization Server prompts the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for
184
+
185
+ <a id="okta-oidc-spec-type-token-url"></a>&#x2022; [`token_url`](#okta-oidc-spec-type-token-url) - Optional String<br>Token URL. The token URL of your OIDC application
186
+
187
+ <a id="okta-oidc-spec-type-user-info-url"></a>&#x2022; [`user_info_url`](#okta-oidc-spec-type-user-info-url) - Optional String<br>User Info URL. The User Info URL specified in your OIDC application
188
+
189
+ #### Timeouts
190
+
191
+ A [`timeouts`](#timeouts) block supports the following:
192
+
193
+ <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
194
+
195
+ <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
196
+
197
+ <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
198
+
199
+ <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
200
+
201
+ ---
202
+
203
+ ## Common Types
204
+
205
+ The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
206
+
207
+ ### Object Reference {#common-object-reference}
208
+
209
+ Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
210
+
211
+ | Field | Type | Description |
212
+ | ----- | ---- | ----------- |
213
+ | `name` | String | Name of the referenced object |
214
+ | `namespace` | String | Namespace containing the referenced object |
215
+ | `tenant` | String | Tenant of the referenced object (system-managed) |
216
+
217
+ ### Transformers {#common-transformers}
218
+
219
+ Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
220
+
221
+ | Value | Description |
222
+ | ----- | ----------- |
223
+ | `LOWER_CASE` | Convert to lowercase |
224
+ | `UPPER_CASE` | Convert to uppercase |
225
+ | `BASE64_DECODE` | Decode base64 content |
226
+ | `NORMALIZE_PATH` | Normalize URL path |
227
+ | `REMOVE_WHITESPACE` | Remove whitespace characters |
228
+ | `URL_DECODE` | Decode URL-encoded characters |
229
+ | `TRIM_LEFT` | Trim leading whitespace |
230
+ | `TRIM_RIGHT` | Trim trailing whitespace |
231
+ | `TRIM` | Trim both leading and trailing whitespace |
232
+
233
+ ### HTTP Methods {#common-http-methods}
234
+
235
+ HTTP methods used for request matching.
236
+
237
+ | Value | Description |
238
+ | ----- | ----------- |
239
+ | `ANY` | Match any HTTP method |
240
+ | `GET` | HTTP GET request |
241
+ | `HEAD` | HTTP HEAD request |
242
+ | `POST` | HTTP POST request |
243
+ | `PUT` | HTTP PUT request |
244
+ | `DELETE` | HTTP DELETE request |
245
+ | `CONNECT` | HTTP CONNECT request |
246
+ | `OPTIONS` | HTTP OPTIONS request |
247
+ | `TRACE` | HTTP TRACE request |
248
+ | `PATCH` | HTTP PATCH request |
249
+ | `COPY` | HTTP COPY request (WebDAV) |
250
+
251
+ ### TLS Fingerprints {#common-tls-fingerprints}
252
+
253
+ TLS fingerprint categories for malicious client detection.
254
+
255
+ | Value | Description |
256
+ | ----- | ----------- |
257
+ | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
258
+ | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
259
+ | `ADWARE` | Adware-associated fingerprints |
260
+ | `DRIDEX` | Dridex malware fingerprints |
261
+ | `GOOTKIT` | Gootkit malware fingerprints |
262
+ | `RANSOMWARE` | Ransomware-associated fingerprints |
263
+ | `TRICKBOT` | Trickbot malware fingerprints |
264
+
265
+ ### IP Threat Categories {#common-ip-threat-categories}
266
+
267
+ IP address threat categories for security filtering.
268
+
269
+ | Value | Description |
270
+ | ----- | ----------- |
271
+ | `SPAM_SOURCES` | Known spam sources |
272
+ | `WINDOWS_EXPLOITS` | Windows exploit sources |
273
+ | `WEB_ATTACKS` | Web attack sources |
274
+ | `BOTNETS` | Known botnet IPs |
275
+ | `SCANNERS` | Network scanner IPs |
276
+ | `REPUTATION` | Poor reputation IPs |
277
+ | `PHISHING` | Phishing-related IPs |
278
+ | `PROXY` | Anonymous proxy IPs |
279
+ | `MOBILE_THREATS` | Mobile threat sources |
280
+ | `TOR_PROXY` | Tor exit nodes |
281
+ | `DENIAL_OF_SERVICE` | DoS attack sources |
282
+ | `NETWORK` | Known bad network ranges |
283
+
284
+ ## Import
285
+
286
+ Import is supported using the following syntax:
287
+
288
+ ```shell
289
+ # Import using namespace/name format
290
+ terraform import f5xc_oidc_provider.example system/example
291
+ ```
@@ -0,0 +1,187 @@
1
+ ---
2
+ page_title: "f5xc_quota Resource - terraform-provider-f5xc"
3
+ subcategory: "Organization"
4
+ description: |-
5
+ Manages quota creates a given object from storage backend for metadata.namespace. in F5 Distributed Cloud.
6
+ ---
7
+
8
+ # f5xc_quota (Resource)
9
+
10
+ Manages quota creates a given object from storage backend for metadata.namespace. in F5 Distributed Cloud.
11
+
12
+ ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
+
14
+ ## Example Usage
15
+
16
+ ```terraform
17
+ # Quota Resource Example
18
+ # Manages quota creates a given object from storage backend for metadata.namespace. in F5 Distributed Cloud.
19
+
20
+ # Basic Quota configuration
21
+ resource "f5xc_quota" "example" {
22
+ name = "example-quota"
23
+ namespace = "staging"
24
+
25
+ labels = {
26
+ environment = "production"
27
+ managed_by = "terraform"
28
+ }
29
+
30
+ annotations = {
31
+ "owner" = "platform-team"
32
+ }
33
+
34
+ # Resource-specific configuration
35
+ # API Limits. API Limits defines ratelimit parameters for a...
36
+ api_limits {
37
+ # Configure api_limits settings
38
+ }
39
+ # Object Limits. Object Limits define maximum number of ins...
40
+ object_limits {
41
+ # Configure object_limits settings
42
+ }
43
+ # Resource Limits. Resource Limits define maximum value of ...
44
+ resource_limits {
45
+ # Configure resource_limits settings
46
+ }
47
+ }
48
+ ```
49
+
50
+ <!-- schema generated by tfplugindocs -->
51
+ ## Argument Reference
52
+
53
+ ### Metadata Argument Reference
54
+
55
+ <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Quota. Must be unique within the namespace
56
+
57
+ <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Quota will be created
58
+
59
+ <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
60
+
61
+ <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
62
+
63
+ <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
64
+
65
+ <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
66
+
67
+ ### Spec Argument Reference
68
+
69
+ <a id="api-limits"></a>&#x2022; [`api_limits`](#api-limits) - Optional Block<br>API Limits. API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. 'ves.io.schema.advertise_policy.API.Create'
70
+
71
+ <a id="object-limits"></a>&#x2022; [`object_limits`](#object-limits) - Optional Block<br>Object Limits. Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. 'virtual_host'
72
+
73
+ <a id="resource-limits"></a>&#x2022; [`resource_limits`](#resource-limits) - Optional Block<br>Resource Limits. Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name
74
+
75
+ <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
76
+
77
+ ### Attributes Reference
78
+
79
+ In addition to all arguments above, the following attributes are exported:
80
+
81
+ <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
82
+
83
+ ---
84
+
85
+ #### Timeouts
86
+
87
+ A [`timeouts`](#timeouts) block supports the following:
88
+
89
+ <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
90
+
91
+ <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
92
+
93
+ <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
94
+
95
+ <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
96
+
97
+ ---
98
+
99
+ ## Common Types
100
+
101
+ The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
102
+
103
+ ### Object Reference {#common-object-reference}
104
+
105
+ Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
106
+
107
+ | Field | Type | Description |
108
+ | ----- | ---- | ----------- |
109
+ | `name` | String | Name of the referenced object |
110
+ | `namespace` | String | Namespace containing the referenced object |
111
+ | `tenant` | String | Tenant of the referenced object (system-managed) |
112
+
113
+ ### Transformers {#common-transformers}
114
+
115
+ Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
116
+
117
+ | Value | Description |
118
+ | ----- | ----------- |
119
+ | `LOWER_CASE` | Convert to lowercase |
120
+ | `UPPER_CASE` | Convert to uppercase |
121
+ | `BASE64_DECODE` | Decode base64 content |
122
+ | `NORMALIZE_PATH` | Normalize URL path |
123
+ | `REMOVE_WHITESPACE` | Remove whitespace characters |
124
+ | `URL_DECODE` | Decode URL-encoded characters |
125
+ | `TRIM_LEFT` | Trim leading whitespace |
126
+ | `TRIM_RIGHT` | Trim trailing whitespace |
127
+ | `TRIM` | Trim both leading and trailing whitespace |
128
+
129
+ ### HTTP Methods {#common-http-methods}
130
+
131
+ HTTP methods used for request matching.
132
+
133
+ | Value | Description |
134
+ | ----- | ----------- |
135
+ | `ANY` | Match any HTTP method |
136
+ | `GET` | HTTP GET request |
137
+ | `HEAD` | HTTP HEAD request |
138
+ | `POST` | HTTP POST request |
139
+ | `PUT` | HTTP PUT request |
140
+ | `DELETE` | HTTP DELETE request |
141
+ | `CONNECT` | HTTP CONNECT request |
142
+ | `OPTIONS` | HTTP OPTIONS request |
143
+ | `TRACE` | HTTP TRACE request |
144
+ | `PATCH` | HTTP PATCH request |
145
+ | `COPY` | HTTP COPY request (WebDAV) |
146
+
147
+ ### TLS Fingerprints {#common-tls-fingerprints}
148
+
149
+ TLS fingerprint categories for malicious client detection.
150
+
151
+ | Value | Description |
152
+ | ----- | ----------- |
153
+ | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
154
+ | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
155
+ | `ADWARE` | Adware-associated fingerprints |
156
+ | `DRIDEX` | Dridex malware fingerprints |
157
+ | `GOOTKIT` | Gootkit malware fingerprints |
158
+ | `RANSOMWARE` | Ransomware-associated fingerprints |
159
+ | `TRICKBOT` | Trickbot malware fingerprints |
160
+
161
+ ### IP Threat Categories {#common-ip-threat-categories}
162
+
163
+ IP address threat categories for security filtering.
164
+
165
+ | Value | Description |
166
+ | ----- | ----------- |
167
+ | `SPAM_SOURCES` | Known spam sources |
168
+ | `WINDOWS_EXPLOITS` | Windows exploit sources |
169
+ | `WEB_ATTACKS` | Web attack sources |
170
+ | `BOTNETS` | Known botnet IPs |
171
+ | `SCANNERS` | Network scanner IPs |
172
+ | `REPUTATION` | Poor reputation IPs |
173
+ | `PHISHING` | Phishing-related IPs |
174
+ | `PROXY` | Anonymous proxy IPs |
175
+ | `MOBILE_THREATS` | Mobile threat sources |
176
+ | `TOR_PROXY` | Tor exit nodes |
177
+ | `DENIAL_OF_SERVICE` | DoS attack sources |
178
+ | `NETWORK` | Known bad network ranges |
179
+
180
+ ## Import
181
+
182
+ Import is supported using the following syntax:
183
+
184
+ ```shell
185
+ # Import using namespace/name format
186
+ terraform import f5xc_quota.example system/example
187
+ ```