xcsh_third_party_application (Data Source)

Retrieves information about a Third Party Application resource in F5 Distributed Cloud for third party application specification. configuration. (read-only data source)

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# ThirdPartyApplication Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing ThirdPartyApplication by name
data "xcsh_third_party_application" "example" {
  name      = "example-third-party-application"
  namespace = "staging"
}

output "third_party_application_id" {
  value = data.xcsh_third_party_application.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

Metadata Argument Reference

• name - Required String
Name of the ThirdPartyApplication to look up

• namespace - Required String
Namespace of the ThirdPartyApplication

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• annotations - Optional Map
Annotations

• api_specification - Optional String
Settings for API specification (API definition, OpenAPI validation, etc.)

• default_sensitive_data_policy - Optional Object
Policy configuration for this feature

• description - Optional String
Description

• disable_api_definition - Optional Object
Enable this option

• disable_api_discovery - Optional Object
Enable this option

• enable_api_discovery - Optional String
Specifies the settings used for API discovery

• id - Optional String
Unique identifier

• labels - Optional Map
Labels

• sensitive_data_policy - Optional String
Policy configuration for this feature

• api_definition - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• validation_all_spec_endpoints - Optional String
API Inventory. Settings for API Inventory validation

• validation_custom_list - Optional String
Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to ‘Fall Through Mode’

• validation_disabled - Optional Object
Enable this option

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• fall_through_mode - Optional String
Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn’t have a specific rule in custom rules)

• settings - Optional String
OpenAPI specification validation settings relevant for ‘API Inventory’ enforcement and for ‘Custom list’ enforcement

• validation_mode - Optional String
Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger)

• fall_through_mode_allow - Optional Object
Configuration parameter for fall through mode allow

• fall_through_mode_custom - Optional String
Configuration parameter for fall through mode custom

• open_api_validation_rules - Optional List
Custom Fall Through Rule List. Rule or policy definition

• action_block - Optional Object
Enable this option

• action_report - Optional Object
Enable this option

• action_skip - Optional Object
Enable this option

• api_endpoint - Optional String
API Endpoint. This defines API endpoint

• api_group - Optional String
The API group which this validation applies to

• base_path - Optional String
The base path which this validation applies to

• metadata - Optional String
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create

• methods - Optional List Defaults to ANY
See HTTP Methods
Methods. Methods to be matched

• path - Optional String
Path. Path to be matched

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• oversized_body_fail_validation - Optional Object
Enable this option

• oversized_body_skip_validation - Optional Object
Enable this option

• property_validation_settings_custom - Optional String
Configuration parameter for property validation settings custom

• property_validation_settings_default - Optional Object
Configuration parameter for property validation settings default

• query_parameters - Optional String
Custom settings for query parameters validation

• allow_additional_parameters - Optional Object
Configuration parameter for allow additional parameters

• disallow_additional_parameters - Optional Object
Configuration parameter for disallow additional parameters

• response_validation_mode_active - Optional String
Open API Validation Mode Active. Validation mode properties of response

• skip_response_validation - Optional Object
Enable this option

• skip_validation - Optional Object
Enable this option

• validation_mode_active - Optional String
Enable OpenAPI validation and explicitly select enforcement_report to allow and log invalid traffic, or enforcement_block to reject invalid requests with HTTP 403

• enforcement_block - Optional Object
Blocking validation: reject traffic that violates the selected OpenAPI validation properties. Invalid requests are returned as HTTP 403

• enforcement_report - Optional Object
Report-only validation: record OpenAPI violations while allowing the request or response to continue

• response_validation_properties - Optional List Defaults to PROPERTY_QUERY_PARAMETERS
Possible values are PROPERTY_QUERY_PARAMETERS, PROPERTY_PATH_PARAMETERS, PROPERTY_CONTENT_TYPE, PROPERTY_COOKIE_PARAMETERS, PROPERTY_HTTP_HEADERS, PROPERTY_HTTP_BODY, PROPERTY_SECURITY_SCHEMA, PROPERTY_RESPONSE_CODE
[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] List of properties of the response to validate according to the OpenAPI specification file (a.k.a. Swagger)

• enforcement_block - Optional Object
Blocking validation: reject traffic that violates the selected OpenAPI validation properties. Invalid requests are returned as HTTP 403

• enforcement_report - Optional Object
Report-only validation: record OpenAPI violations while allowing the request or response to continue

• request_validation_properties - Optional List Defaults to PROPERTY_QUERY_PARAMETERS
Possible values are PROPERTY_QUERY_PARAMETERS, PROPERTY_PATH_PARAMETERS, PROPERTY_CONTENT_TYPE, PROPERTY_COOKIE_PARAMETERS, PROPERTY_HTTP_HEADERS, PROPERTY_HTTP_BODY, PROPERTY_SECURITY_SCHEMA, PROPERTY_RESPONSE_CODE
[Enum: PROPERTY_QUERY_PARAMETERS|PROPERTY_PATH_PARAMETERS|PROPERTY_CONTENT_TYPE|PROPERTY_COOKIE_PARAMETERS|PROPERTY_HTTP_HEADERS|PROPERTY_HTTP_BODY|PROPERTY_SECURITY_SCHEMA|PROPERTY_RESPONSE_CODE] List of properties of the request to validate according to the OpenAPI specification file (a.k.a. Swagger)

• fall_through_mode - Optional String
Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn’t have a specific rule in custom rules)

• open_api_validation_rules - Optional List
Validation List. Rule or policy definition

• settings - Optional String
OpenAPI specification validation settings relevant for ‘API Inventory’ enforcement and for ‘Custom list’ enforcement

• fall_through_mode_allow - Optional Object
Configuration parameter for fall through mode allow

• fall_through_mode_custom - Optional String
Configuration parameter for fall through mode custom

• open_api_validation_rules - Optional List
Custom Fall Through Rule List. Rule or policy definition

• action_block - Optional Object
Enable this option

• action_report - Optional Object
Enable this option

• action_skip - Optional Object
Enable this option

• api_endpoint - Optional String
API Endpoint. This defines API endpoint

• api_group - Optional String
The API group which this validation applies to

• base_path - Optional String
The base path which this validation applies to

• methods - Optional List Defaults to ANY
See HTTP Methods
Methods. Methods to be matched

• path - Optional String
Path. Path to be matched

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• any_domain - Optional Object
Enable this option

• api_endpoint - Optional String
API Endpoint. This defines API endpoint

• api_group - Optional String
The API group which this validation applies to

• base_path - Optional String
The base path which this validation applies to

• specific_domain - Optional String
The rule will apply for a specific domain

• methods - Optional List Defaults to ANY
See HTTP Methods
Methods. Methods to be matched

• path - Optional String
Path. Path to be matched

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• response_validation_mode_active - Optional String
Open API Validation Mode Active. Validation mode properties of response

• skip_response_validation - Optional Object
Enable this option

• skip_validation - Optional Object
Enable this option

• enforcement_block - Optional Object
Blocking validation: reject traffic that violates the selected OpenAPI validation properties. Invalid requests are returned as HTTP 403

• enforcement_report - Optional Object
Report-only validation: record OpenAPI violations while allowing the request or response to continue

• enforcement_block - Optional Object
Blocking validation: reject traffic that violates the selected OpenAPI validation properties. Invalid requests are returned as HTTP 403

• enforcement_report - Optional Object
Report-only validation: record OpenAPI violations while allowing the request or response to continue

• oversized_body_fail_validation - Optional Object
Enable this option

• oversized_body_skip_validation - Optional Object
Enable this option

• property_validation_settings_custom - Optional String
Configuration parameter for property validation settings custom

• property_validation_settings_default - Optional Object
Configuration parameter for property validation settings default

• query_parameters - Optional String
Custom settings for query parameters validation

• allow_additional_parameters - Optional Object
Configuration parameter for allow additional parameters

• disallow_additional_parameters - Optional Object
Configuration parameter for disallow additional parameters

• api_crawler - Optional String
API Crawling. API Crawler message

• api_discovery_from_code_scan - Optional String
Select codebase and Repositories

• custom_api_auth_discovery - Optional String
API Discovery Advanced Settings. API Discovery Advanced settings

• default_api_auth_discovery - Optional Object
Enable this option

• disable_learn_from_redirect_traffic - Optional Object
Configuration parameter for disable learn from redirect traffic

• discovered_api_settings - Optional String
Discovered API Settings. Configure Discovered API Settings

• enable_learn_from_redirect_traffic - Optional Object
Configuration parameter for enable learn from redirect traffic

• api_crawler_config - Optional String
Crawler Configure

• disable_api_crawler - Optional Object
Enable this option

• domains - Optional List
Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer

• domain - Optional String
Select the domain to execute API Crawling with given credentials

• simple_login - Optional String
Configuration parameter for simple login

• password - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• user - Optional String
Enter the username to assign credentials for the selected domain to crawl

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• code_base_integrations - Optional List
Configuration parameter for codebase integrations

• all_repos - Optional Object
Enable this option

• code_base_integration - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• selected_repos - Optional String
Select which API repositories represent the LB applications

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• api_code_repo - Optional List
Code repository which contain API endpoints

• api_discovery_ref - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• purge_duration_for_inactive_discovered_apis - Optional Number
Inactive discovered API will be deleted after configured duration

• sensitive_data_policy_ref - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
`name`	String	Name of the referenced object
`namespace`	String	Namespace containing the referenced object
`tenant`	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
`LOWER_CASE`	Convert to lowercase
`UPPER_CASE`	Convert to uppercase
`BASE64_DECODE`	Decodebase64 content
`NORMALIZE_PATH`	Normalize URL path
`REMOVE_WHITESPACE`	Remove whitespace characters
`URL_DECODE`	Decode URL-encoded characters
`TRIM_LEFT`	Trim leading whitespace
`TRIM_RIGHT`	Trim trailing whitespace
`TRIM`	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
`ANY`	Match any HTTP method
`GET`	HTTP GET request
`HEAD`	HTTP HEAD request
`POST`	HTTP POST request
`PUT`	HTTP PUT request
`DELETE`	HTTP DELETE request
`CONNECT`	HTTP CONNECT request
`OPTIONS`	HTTP OPTIONS request
`TRACE`	HTTP TRACE request
`PATCH`	HTTP PATCH request
`COPY`	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
`TLS_FINGERPRINT_NONE`	No fingerprint matching
`ANY_MALICIOUS_FINGERPRINT`	Match any known malicious fingerprint
`ADWARE`	Adware-associated fingerprints
`DRIDEX`	Dridex malware fingerprints
`GOOTKIT`	Gootkit malware fingerprints
`RANSOMWARE`	Ransomware-associated fingerprints
`TRICKBOT`	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
`SPAM_SOURCES`	Known spam sources
`WINDOWS_EXPLOITS`	Windows exploit sources
`WEB_ATTACKS`	Web attack sources
`BOTNETS`	Known botnet IPs
`SCANNERS`	Network scanner IPs
`REPUTATION`	Poor reputation IPs
`PHISHING`	Phishing-related IPs
`PROXY`	Anonymous proxy IPs
`MOBILE_THREATS`	Mobile threat sources
`TOR_PROXY`	Tor exit nodes
`DENIAL_OF_SERVICE`	DoS attack sources
`NETWORK`	Known bad network ranges