diff --git a/docs/api-generated/connectors/connector-apis-passthru.asciidoc b/docs/api-generated/connectors/connector-apis-passthru.asciidoc index b68b4e4ca648f..fb1a9b87dbcda 100644 --- a/docs/api-generated/connectors/connector-apis-passthru.asciidoc +++ b/docs/api-generated/connectors/connector-apis-passthru.asciidoc @@ -1015,6 +1015,7 @@ Any modifications made to this file will be overwritten.
  • config_properties_servicenow - Connector request properties for a ServiceNow ITSM connector
  • config_properties_servicenow_itom - Connector request properties for a ServiceNow ITSM connector
  • config_properties_swimlane - Connector request properties for a Swimlane connector
    • +
  • config_properties_tines - Connector request properties for a Tines connector
  • config_properties_torq - Connector request properties for a Torq connector
  • config_properties_webhook - Connector request properties for a Webhook connector
  • config_properties_xmatters - Connector request properties for an xMatters connector
    • @@ -1109,6 +1110,7 @@ Any modifications made to this file will be overwritten.
  • secrets_properties_slack_webhook - Connector secrets properties for a Webhook Slack connector
  • secrets_properties_swimlane - Connector secrets properties for a Swimlane connector
  • secrets_properties_teams - Connector secrets properties for a Microsoft Teams connector
    • +
  • secrets_properties_tines - Connector secrets properties for a Tines connector
  • secrets_properties_torq - Connector secrets properties for a Torq connector
  • secrets_properties_webhook - Connector secrets properties for a Webhook connector
  • secrets_properties_xmatters - Connector secrets properties for an xMatters connector
    • @@ -1128,6 +1130,7 @@ Any modifications made to this file will be overwritten.
  • update_connector_request_slack_webhook - Update Slack connector request
  • update_connector_request_swimlane - Update Swimlane connector request
  • update_connector_request_teams - Update Microsoft Teams connector request
    • +
  • update_connector_request_tines - Update Tines connector request
  • update_connector_request_torq - Update Torq connector request
  • update_connector_request_webhook - Update Webhook connector request
  • update_connector_request_xmatters - Update xMatters connector request
    • @@ -1534,6 +1537,13 @@ Any modifications made to this file will be overwritten.
    mappings (optional)
    Connector_mappings_properties_for_a_Swimlane_connector
    +
    +

    config_properties_tines - Connector request properties for a Tines connector Up

    +
    Defines properties for connectors when type is .tines.
    +
    +
    url
    String The Tines tenant URL. If you are using the xpack.actions.allowedHosts setting, make sure this hostname is added to the allowed hosts.
    +
    +

    config_properties_torq - Connector request properties for a Torq connector Up

    Defines properties for connectors when type is .torq.
    @@ -1845,7 +1855,7 @@ Any modifications made to this file will be overwritten.

    connector_response_properties_tines - Connector response properties for a Tines connector Up

    -
    config
    map[String, oas_any_type_not_mapped] Defines properties for connectors when type is .tines.
    +
    config
    config_properties_tines
    connector_type_id
    String The type of connector.
    Enum:
    .tines
    @@ -2113,12 +2123,12 @@ Any modifications made to this file will be overwritten.

    create_connector_request_tines - Create Tines connector request Up

    The Tines connector uses Tines Webhook actions to send events via POST request.
    -
    config
    map[String, oas_any_type_not_mapped] Defines properties for connectors when type is .tines.
    +
    config
    config_properties_tines
    connector_type_id
    String The type of connector.
    Enum:
    .tines
    name
    String The display name for the connector.
    -
    secrets
    map[String, oas_any_type_not_mapped] Defines secrets for connectors when type is .tines.
    +
    secrets
    secrets_properties_tines
    @@ -2600,6 +2610,14 @@ Any modifications made to this file will be overwritten.
    webhookUrl
    String The URL of the incoming webhook. If you are using the xpack.actions.allowedHosts setting, add the hostname to the allowed hosts.
    +
    +

    secrets_properties_tines - Connector secrets properties for a Tines connector Up

    +
    Defines secrets for connectors when type is .tines.
    +
    +
    email
    String The email used to sign in to Tines.
    +
    token
    String The Tines API token.
    +
    +

    secrets_properties_torq - Connector secrets properties for a Torq connector Up

    Defines secrets for connectors when type is .torq.
    @@ -2765,6 +2783,15 @@ Any modifications made to this file will be overwritten.
    secrets
    secrets_properties_teams
    +
    +

    update_connector_request_tines - Update Tines connector request Up

    +
    +
    +
    config
    config_properties_tines
    +
    name
    String The display name for the connector.
    +
    secrets
    secrets_properties_tines
    +
    +

    update_connector_request_torq - Update Torq connector request Up

    diff --git a/docs/management/connectors/action-types/tines.asciidoc b/docs/management/connectors/action-types/tines.asciidoc index 218de7cb960f2..cdaf56912d0f0 100644 --- a/docs/management/connectors/action-types/tines.asciidoc +++ b/docs/management/connectors/action-types/tines.asciidoc @@ -3,6 +3,10 @@ ++++ Tines ++++ +:frontmatter-description: Add a connector that can use Tines to send events. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [configure] The Tines connector uses Tines's https://www.tines.com/docs/actions/types/webhook[Webhook actions] to send events via POST request. @@ -26,37 +30,6 @@ URL:: The Tines tenant URL. If you are using the <> * <> * <> +* <> * <> * <> * <> @@ -530,6 +531,28 @@ xpack.actions.preconfigured: <3> Field mappings for properties such as the alert identifer, severity, and rule name. <4> The API authentication token for HTTP basic authentication. NOTE: This value should be stored in the <>. +[float] +[[preconfigured-tines-configuration]] +==== Tines connectors + +The following example creates a <>: + +[source,text] +-- +xpack.actions.preconfigured: +my-tines: + name: preconfigured-tines-connector-type + actionTypeId: .tines + config: + url: https://some-tenant-2345.tines.com <1> + secrets: + email: some.address@test.com <2> + token: ausergeneratedapitoken <3> +-- +<1> The Tines tenant URL. +<2> The email used to sign in to Tines. +<3> The Tines API token. + [float] [[preconfigured-torq-configuration]] ==== Torq connectors diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc index b3cd5777edd69..8b05c3108df00 100644 --- a/docs/settings/alert-action-settings.asciidoc +++ b/docs/settings/alert-action-settings.asciidoc @@ -420,7 +420,8 @@ NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the h A configuration URL that varies by connector: + -- -* For a <>, specifies the D3 Security API request URL. +* For a <>, specifies the D3 Security API request URL. +* For a <>, specifies the Tines tenant URL. * For a <>, specifies the web service request URL. NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts. @@ -470,7 +471,12 @@ NOTE: The client secret must be URL-encoded. -- `xpack.actions.preconfigured..secrets.email`:: -For a <>, specifies the account email for HTTP basic authentication. +An email address that varies by connector: ++ +-- +* For a <>, specifies the account email for HTTP basic authentication. +* For a <>, specifies the email used to sign in to Tines. +-- `xpack.actions.preconfigured..secrets.password`:: A password secret that varies by connector: @@ -495,6 +501,7 @@ A token secret that varies by connector: -- * For a <>, specifies the D3 Security token. * For a <>, specifies the Slack bot user OAuth token. +* For a <>, specifies the Tines API token. * For a <>, specifies the secret of the webhook authentication header. -- diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index 4039ab6b5a0de..94efaf061fb4f 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -514,6 +514,9 @@ { "$ref": "#/components/schemas/update_connector_request_teams" }, + { + "$ref": "#/components/schemas/update_connector_request_tines" + }, { "$ref": "#/components/schemas/update_connector_request_torq" }, @@ -2798,13 +2801,34 @@ "title": "Connector request properties for a Tines connector", "description": "Defines properties for connectors when type is `.tines`.", "type": "object", - "additionalProperties": true + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.\n", + "type": "string" + } + } }, "secrets_properties_tines": { "title": "Connector secrets properties for a Tines connector", "description": "Defines secrets for connectors when type is `.tines`.", "type": "object", - "additionalProperties": true + "required": [ + "email", + "token" + ], + "properties": { + "email": { + "description": "The email used to sign in to Tines.", + "type": "string" + }, + "token": { + "description": "The Tines API token.", + "type": "string" + } + } }, "create_connector_request_tines": { "title": "Create Tines connector request", @@ -4337,6 +4361,27 @@ } } }, + "update_connector_request_tines": { + "title": "Update Tines connector request", + "type": "object", + "required": [ + "config", + "name", + "secrets" + ], + "properties": { + "config": { + "$ref": "#/components/schemas/config_properties_tines" + }, + "name": { + "type": "string", + "description": "The display name for the connector." + }, + "secrets": { + "$ref": "#/components/schemas/secrets_properties_tines" + } + } + }, "update_connector_request_torq": { "title": "Update Torq connector request", "type": "object", diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml index 9d1842c4dace9..b1ff36d6f3370 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -266,6 +266,7 @@ paths: - $ref: '#/components/schemas/update_connector_request_slack_webhook' - $ref: '#/components/schemas/update_connector_request_swimlane' - $ref: '#/components/schemas/update_connector_request_teams' + - $ref: '#/components/schemas/update_connector_request_tines' - $ref: '#/components/schemas/update_connector_request_torq' - $ref: '#/components/schemas/update_connector_request_webhook' - $ref: '#/components/schemas/update_connector_request_xmatters' @@ -1888,12 +1889,27 @@ components: title: Connector request properties for a Tines connector description: Defines properties for connectors when type is `.tines`. type: object - additionalProperties: true + required: + - url + properties: + url: + description: | + The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts. + type: string secrets_properties_tines: title: Connector secrets properties for a Tines connector description: Defines secrets for connectors when type is `.tines`. type: object - additionalProperties: true + required: + - email + - token + properties: + email: + description: The email used to sign in to Tines. + type: string + token: + description: The Tines API token. + type: string create_connector_request_tines: title: Create Tines connector request description: | @@ -3003,6 +3019,21 @@ components: description: The display name for the connector. secrets: $ref: '#/components/schemas/secrets_properties_teams' + update_connector_request_tines: + title: Update Tines connector request + type: object + required: + - config + - name + - secrets + properties: + config: + $ref: '#/components/schemas/config_properties_tines' + name: + type: string + description: The display name for the connector. + secrets: + $ref: '#/components/schemas/secrets_properties_tines' update_connector_request_torq: title: Update Torq connector request type: object diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml index 336a312d9ac8e..2bb480d7c18b2 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml @@ -1,5 +1,11 @@ title: Connector request properties for a Tines connector description: Defines properties for connectors when type is `.tines`. type: object -additionalProperties: true -# TO-DO: Add the properties for this connector. \ No newline at end of file +required: + - url +properties: + url: + description: > + The Tines tenant URL. + If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts. + type: string \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_tines.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_tines.yaml index 2373f14beae50..e480505dc1938 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_tines.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_tines.yaml @@ -1,5 +1,13 @@ title: Connector secrets properties for a Tines connector description: Defines secrets for connectors when type is `.tines`. type: object -additionalProperties: true -# TO-DO: Add the properties for this connector. \ No newline at end of file +required: + - email + - token +properties: + email: + description: The email used to sign in to Tines. + type: string + token: + description: The Tines API token. + type: string \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml index ad93b5076639a..d85e38cff5f75 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml @@ -176,7 +176,7 @@ put: - $ref: '../components/schemas/update_connector_request_slack_webhook.yaml' - $ref: '../components/schemas/update_connector_request_swimlane.yaml' - $ref: '../components/schemas/update_connector_request_teams.yaml' -# - $ref: '../components/schemas/update_connector_request_tines.yaml' + - $ref: '../components/schemas/update_connector_request_tines.yaml' - $ref: '../components/schemas/update_connector_request_torq.yaml' - $ref: '../components/schemas/update_connector_request_webhook.yaml' - $ref: '../components/schemas/update_connector_request_xmatters.yaml'