Skip to content

Commit b79e0c7

Browse files
jpipkin1kimsauce
jpipkin1
and
kimsauce
authored
DOCS-888 - Add descriptions of the fields on configuration dialogs for automation integrations (#5387)
* AWS Athena, AWS CloudFront, and AWS WAF * Finish AWS integrations * Fix spelling errors * Set up reuse * Added reuse to AWS articles * Add bullets * Fix build break * Another attempt to fix build break * A integrations * Fix broken anchor * Finish A integrations * B integrations * Start C integrations * Continue C integrations * Finish C integrations * D integrations * Fix spelling error * E integrations * Start F integrations * Add F-G integrations * Fix broken link * H integrations * Fix spelling error * I integrations * J integrations * K integrations * L integrations * M integrations * N-O integrations * P integrations * Fix spelling error * Q-R integrations * Start S integrations * Finish S integrations * Fix broken link * T-Z integrations * Updates from review * Update docs/platform-services/automation-service/app-central/integrations/trend-micro-deep-security.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Final updates --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 0b411a3 commit b79e0c7

File tree

351 files changed

+5670
-667
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

351 files changed

+5670
-667
lines changed

‎docs/api/aws-region-by-deployment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ sidebar_label: AWS Regions by Deployment
55
description: This guide contains information about API authentication and the Sumo Logic endpoints to use for your API client.
66
---
77

8-
import AwsRegion from '../reuse/aws-region-by-sumo-deployment.md';
8+
import AWSDeploymentRegion from '../reuse/aws-region-by-sumo-deployment.md';
99

10-
<AwsRegion/>
10+
* <AWSDeploymentRegion/>

‎docs/api/getting-started.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ Sumo Logic's FedRAMP deployment is similar to our other deployments, such as US2
132132

133133
### AWS region by Sumo Logic deployment
134134

135-
import AwsRegion from '../reuse/aws-region-by-sumo-deployment.md';
135+
import AWSDeploymentRegion from '../reuse/aws-region-by-sumo-deployment.md';
136136

137-
<AwsRegion/>
137+
* <AWSDeploymentRegion/>
138138

139139
## Status codes
140140

‎docs/platform-services/automation-service/app-central/integrations/abnormal-security.md‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,24 @@ Abnormal Security provides advanced email security to prevent credential phishin
2828
## Configure Abnormal Security in Automation Service and Cloud SOAR
2929

3030
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
31+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
32+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
33+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
34+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
35+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
3136

3237
<IntegrationsAuth/>
3338

34-
* **Label**. The name for the resource.
35-
* **URL API**. Abnormal Security URL API. Default: 'https://api.abnormalplatform.com'
36-
* **Token**. Retrieved from Abnormal Security. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/abnormal-security-configuration.png')} style={{border:'1px solid gray'}} alt="Abnormal Security configuration" width="400"/>
39+
* <IntegrationLabel/>
40+
* **URL API**. Enter your [Abnormal Security API](https://abnormalsecurity.my.site.com/knowledgebase/s/article/Abnormal-REST-API-Integration) URL. The default is `https://api.abnormalplatform.com`
41+
42+
* **Token**. Enter your [token](https://abnormalsecurity.my.site.com/knowledgebase/s/article/Abnormal-REST-API-Integration) retrieved from Abnormal Security.
43+
* <IntegrationCertificate/>
44+
* <IntegrationTimeout/>
45+
* <IntegrationEngine/>
46+
* <IntegrationProxy/>
47+
48+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/abnormal-security-configuration.png')} style={{border:'1px solid gray'}} alt="Abnormal Security configuration" width="400"/>
3749

3850
For information about Abnormal Security, see [Abnormal Security documentation](https://abnormalsecurity.my.site.com/knowledgebase/s/).
3951

‎docs/platform-services/automation-service/app-central/integrations/abuse.ch-sslbl-feed.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,20 @@ An SSL certificate can be associated with one or more servers (IP address:port c
2525
## Configure Abuse.ch SSLBL Feed in Automation Service and Cloud SOAR
2626

2727
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
28+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
29+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
30+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
31+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
32+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
2833

2934
<IntegrationsAuth/>
3035

36+
* <IntegrationLabel/>
37+
* <IntegrationTimeout/>
38+
* <IntegrationCertificate/>
39+
* <IntegrationEngine/>
40+
* <IntegrationProxy/>
41+
3142
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/abuse-ch-sslbl-configuration.png')} style={{border:'1px solid gray'}} alt="Abuse.ch SSLBL configuration" width="400"/>
3243

3344
For information about Abuse.ch SSLBL, see [Abuse.ch SSLBL documentation](https://sslbl.abuse.ch/).

‎docs/platform-services/automation-service/app-central/integrations/abuseipdb.md‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,24 @@ Enrich IP addresses with reputation information gathered from AbuseIPDB.
3232
## Configure AbuseIPDB in Automation Service and Cloud SOAR
3333

3434
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
35+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
36+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
37+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
38+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
39+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
3540

3641
<IntegrationsAuth/>
3742

38-
* **Label**. Enter a name for the resource.
39-
* **API URL**. Enter `https://api.abuseipdb.com`
40-
* **API Key**. Enter the API key you copied earlier. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/abuseipdf/abuseipdf-1.png')} style={{border:'1px solid gray'}} alt="any.run-3" width="400"/>
43+
* <IntegrationLabel/>
44+
* **API URL**. Enter `https://api.abuseipdb.com`
45+
46+
* **API Key**. Enter the [API key](https://www.abuseipdb.com/api.html) you copied [above](#create-an-api-key).
47+
* <IntegrationTimeout/>
48+
* <IntegrationCertificate/>
49+
* <IntegrationEngine/>
50+
* <IntegrationProxy/>
51+
52+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/abuseipdf/abuseipdf-1.png')} style={{border:'1px solid gray'}} alt="any.run-3" width="400"/>
4153

4254
For information about AbuseIPDB, see [AbuseIPDB documentation](https://www.abuseipdb.com/api.html).
4355

‎docs/platform-services/automation-service/app-central/integrations/acronis.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Acronis develops on-premises and cloud software with integration of backup, disa
1717

1818
## Acronis configuration
1919

20-
Follow these steps to get your API key from Arconis.
20+
Follow these steps to get your [API key](https://developer.acronis.com/doc/connector/authentication/index.html) from Arconis.
2121

2222
1. Select **Manage account** from the dashboard. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/acronis/acronis-1.png')} style={{border:'1px solid gray'}} alt="acronis-1" width="400"/>
2323
1. From the **SETTINGS** select **API clients**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/acronis/acronis-2.png')} style={{border:'1px solid gray'}} alt="acronis-2" width="400"/>
@@ -27,13 +27,26 @@ Follow these steps to get your API key from Arconis.
2727
## Configure Acronis in Automation Service and Cloud SOAR
2828

2929
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
30+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
31+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
32+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
33+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
34+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
3035

3136
<IntegrationsAuth/>
3237

33-
* **Label**. The desired name for the resource.
34-
* **URL**. Your Acronis Data Center URL you copied earlier from Acronis. Default: 'https://cloud.acronis.com'/ .
35-
* **Client ID**. Your Acronis Client ID you copied earlier from Acronis.
36-
* **Client Secret**. Your Acronis Secret you copied earlier from Acronis. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/acronis-configuration.png')} style={{border:'1px solid gray'}} alt="Acronis configuration" width="400"/>
38+
* <IntegrationLabel/>
39+
* **URL**. Enter the Acronis Data Center URL you copied [above](#acronis-configuration). The default is `https://cloud.acronis.com`.
40+
41+
* **Client ID**. Enter the Acronis Client ID you copied above.
42+
43+
* **Client Secret**. The the Acronis Secret you copied above.
44+
* <IntegrationTimeout/>
45+
* <IntegrationCertificate/>
46+
* <IntegrationEngine/>
47+
* <IntegrationProxy/>
48+
49+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/acronis-configuration.png')} style={{border:'1px solid gray'}} alt="Acronis configuration" width="400"/>
3750

3851
For information about Acronis, see [Acronis documentation](https://developer.acronis.com/doc/).
3952

‎docs/platform-services/automation-service/app-central/integrations/active-directory-v2.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,43 @@ If an existing Windows Server is not available, follow these steps to set up a n
7979
## Configure Active Directory V2 in Automation Service and Cloud SOAR
8080

8181
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
82+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
83+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
84+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
85+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
86+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
8287

8388
<IntegrationsAuth/>
8489

85-
* **Host**. The hostname or IP address of the AD server.
86-
* **Login Port**. The port used for LDAP authentication (the default is `389` for LDAP and `636` for LDAPS).
87-
* **Login DN (Distinguished Name)**. Enter the distinguished name format (for example, `CN=Administrator,CN=Users,DC=csoar,DC=com`). See the following sections for information about how to get the login DN.
88-
* **Password**. The corresponding password for the provided username.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-configuration.png')} style={{border:'1px solid gray'}} alt="Active Directory V2 configuration" width="400"/>
90+
* <IntegrationLabel/>
91+
* **Host**. The hostname or IP address of the AD server.
92+
93+
* **Login Port**. The port used for LDAP authentication. The default is `389` for LDAP and `636` for LDAPS.
94+
95+
* **Login DN (Distinguished Name)**. Enter the distinguished name format (for example, `CN=Administrator,CN=Users,DC=csoar,DC=com`). See the [following sections](#how-to-get-login-dn-with-a-local-account) for information about how to get the login DN.
96+
97+
* **Password**. The corresponding password for the provided username.
98+
99+
* **Connection Security**. Select the type of security to use for communication (**SSL**, **NonSSL**, **StartTLS**, or **LDAP over TLS**).
100+
101+
* **CA Certificate Format**. Select the format (**PFX, P12** or **PEM**).
102+
103+
* **CA Certificate**. Enter the certificate. Only required if you selected **LDAP over TLS**. The certificate must be in Base64 encoded format.
104+
105+
* **Certificate Passphrase**. Enter the passphrase. Only required if you selected the **PFX, P12** certificate format.
106+
107+
* **Base DN**. Enter the Base Distinguished Name.
108+
109+
* **Global Catalog or DN Port**. Select the catalog or port. For global catalog, select port 3268 for LDAP or 3269 for secure LDAP.
110+
111+
* <IntegrationTimeout/>
112+
* **Docker Hostnames**. Enter the container's hostname.
113+
114+
* <IntegrationCertificate/>
115+
* <IntegrationEngine/>
116+
* <IntegrationProxy/>
117+
118+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-v2-configuration.png')} style={{border:'1px solid gray'}} alt="Active Directory V2 configuration" width="400"/>
89119

90120
For information about Microsoft Entra Connect V2 (formerly Active Directory V2), see [Microsoft Entra Connect V2 documentation](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/whatis-azure-ad-connect-v2).
91121

‎docs/platform-services/automation-service/app-central/integrations/active-directory.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,27 @@ Utilize user, group, and system information from Active Directory.
3737
## Configure Active Directory in Automation Service and Cloud SOAR
3838

3939
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
40+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
41+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
42+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
43+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
44+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
4045

4146
<IntegrationsAuth/>
4247

48+
* <IntegrationLabel/>
49+
* **Host**. The hostname or IP address of the AD server.
50+
51+
* **Login Port**. The port used for LDAP authentication. The default is `389` for LDAP and `636` for LDAPS.
52+
53+
* **Login DN (Username)**. Enter the distinguished name format (for example, `CN=Administrator,CN=Users,DC=csoar,DC=com`). See the following sections for information about how to get the login DN.
54+
55+
* **Password**. The corresponding password for the provided username.
56+
57+
* **Base DN**. Enter the Base Distinguished Name.
58+
59+
* **Global Catalog or DN Port**. Select the catalog or port. For global catalog, select port 3268 for LDAP or 3269 for secure LDAP.
60+
4361
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/active-directory-v2/active-directory-configuration.png')} style={{border:'1px solid gray'}} alt="Active Directory configuration" width="400"/>
4462

4563
For information about Active Directory, see [Active Directory documentation](https://learn.microsoft.com/en-us/troubleshoot/windows-server/active-directory/active-directory-overview).

‎docs/platform-services/automation-service/app-central/integrations/airtable.md‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,31 @@ Updated: Jul 18, 2023**
2222
## Airtable configuration
2323

2424
1. Sign in to the Airtable platform with your email ID and password. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/airtable/airtable-1.png')} style={{border:'1px solid gray'}} alt="airtable-1" width="800"/>
25-
1. Create your token, refer to the [Developer hub page](https://airtable.com/developers/web/guides/personal-access-tokens).
25+
1. To create your token, refer to the [Airtable documentation](https://airtable.com/developers/web/guides/personal-access-tokens).
2626

2727
## Configure Airtable in Automation Service and Cloud SOAR
2828

2929
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
30+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
31+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
32+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
33+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
34+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
3035

3136
<IntegrationsAuth/>
3237

33-
* URL: default value for API URL is 'https://api.airtable.com'
34-
* Token : the Token you copied earlier. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/airtable-configuration.png')} style={{border:'1px solid gray'}} alt="Airtable configuration" width="400"/>
38+
* <IntegrationLabel/>
39+
* **URL**. Enter the Airtable API URL. The default value is `https://api.airtable.com`
40+
41+
* **Token**. Enter the token you copied [above](#airtable-configuration).
42+
* <IntegrationCertificate/>
43+
* <IntegrationTimeout/>
44+
* <IntegrationEngine/>
45+
* <IntegrationProxy/>
46+
47+
48+
49+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/airtable-configuration.png')} style={{border:'1px solid gray'}} alt="Airtable configuration" width="400"/>
3550

3651
For information about Airtable, see [Airtable documentation](https://support.airtable.com/docs).
3752

‎docs/platform-services/automation-service/app-central/integrations/akenza.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,29 @@ Updated: Jul 18, 2023***
2828
## Akenza configuration
2929

3030
1. Log in to the Akenza platform with your email and password and follow the link for configuration.
31-
1. Create API key from GUI of Akenza by locating to API key and by clicking on the button Generate API Key.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/akenza/akenza-1.png')} style={{border:'1px solid gray'}} alt="akenza-1" width="800"/>
31+
1. Create an [API key](https://docs.akenza.io/akenza.io/get-started/reference/api-documentation#api-keys) in the Akenza UI by locating an API key and clicking on the button **Generate API Key**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/akenza/akenza-1.png')} style={{border:'1px solid gray'}} alt="akenza-1" width="800"/>
3232

3333
## Configure Akenza in Automation Service and Cloud SOAR
3434

3535
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
36+
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
37+
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
38+
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
39+
import IntegrationProxy from '../../../../reuse/automation-service/integration-proxy.md';
40+
import IntegrationTimeout from '../../../../reuse/automation-service/integration-timeout.md';
3641

3742
<IntegrationsAuth/>
3843

39-
* **URL**. Default value for API URL is 'https://api.akenza.io'
40-
* **Api Key**. The API Key you created earlier.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/Akenza-configuration.png')} style={{border:'1px solid gray'}} alt="Akenza configuration" width="400"/>
44+
* <IntegrationLabel/>
45+
* **URL**. Enter the Akenza API URL. The default value is `https://api.akenza.io`
46+
47+
* **API Key**. Enter the API key you created [above](#akenza-configuration).
48+
* <IntegrationCertificate/>
49+
* <IntegrationTimeout/>
50+
* <IntegrationEngine/>
51+
* <IntegrationProxy/>
52+
53+
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/Akenza-configuration.png')} style={{border:'1px solid gray'}} alt="Akenza configuration" width="400"/>
4154

4255
For information about Akenza, see [Akenza documentation](https://docs.akenza.io/akenza.io/get-started/reference/api-documentation).
4356

0 commit comments

Comments
 (0)