You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/sentinel/data-connector-connection-rules-reference.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,7 +143,7 @@ The result of this example is the secret defined from the user input sent in the
143
143
}
144
144
```
145
145
146
-
This example uses the default values and results in the following header: Authorization: `token 123123123`.
146
+
This example uses the default values and results in the following header: `Authorization`: `token 123123123`.
147
147
148
148
```json
149
149
"auth": {
@@ -153,7 +153,7 @@ This example uses the default values and results in the following header: Author
153
153
}
154
154
```
155
155
156
-
Because `ApiKeyName` is explicitly set to `""`, the result is the following header: Authorization: `123123123`.
156
+
Because `ApiKeyName` is explicitly set to `""`, the result is the following header: `Authorization`: `123123123`.
157
157
158
158
#### OAuth2
159
159
@@ -224,7 +224,7 @@ Here's an example of the OAuth2 `client_credentials` grant type:
224
224
225
225
JSON Web Token (JWT) authentication supports obtaining tokens via username and password credentials and using them for API requests.
226
226
227
-
##### Basic Example
227
+
##### Basic example
228
228
229
229
```json
230
230
"auth": {
@@ -331,9 +331,9 @@ Follow this authentication flow:
331
331
|`TokenEndpoint`| True | String | The URL endpoint that's used to obtain the JWT token. |
332
332
|`IsCredentialsInHeaders`|| Boolean | The value that indicates whether to send credentials as a basic authentication header (`true`) versus a `POST` body (`false`). The default is `false`. |
333
333
|`IsJsonRequest`|| Boolean | The value that indicates whether to send the request in JSON (header `Content-Type = application/json`) versus form-encoded (header `Content-Type = application/x-www-form-urlencoded`). The default is `false`. |
334
-
|`JwtTokenJsonPath`|| String | The value that indicates the `JSONPath` value to use to extract the token from the response. For example: "`$.access_token`"). |
334
+
|`JwtTokenJsonPath`|| String | The value that indicates the `JSONPath` value to use to extract the token from the response. For example: `$.access_token`). |
335
335
|`JwtTokenInResponseHeader`|| Boolean | The value that indicates whether to extract the token from the response header versus the body. The default is `false`. |
336
-
|`JwtTokenHeaderName`. || String | The value that indicates the header name when the token is in the response header. The default is "`Authorization`"|
336
+
|`JwtTokenHeaderName`. || String | The value that indicates the header name when the token is in the response header. The default is `Authorization`.|
337
337
|`JwtTokenIdentifier`|| String | The identifier used to extract the JWT from a prefixed token string. |
338
338
|`QueryParameters`|| Object | The custom query parameters to include when sending the request to the token endpoint. |
339
339
|`Headers`|| Object | The custom headers to include when sending the request to the token endpoint. |
@@ -343,8 +343,8 @@ Follow this authentication flow:
343
343
344
344
1. Send credentials to `TokenEndpoint` to obtain the JWT token.
345
345
346
-
- If `IsCredentialsInHeaders: true`: Sends a basic authentication header with `username:password`.
347
-
- If `IsCredentialsInHeaders: false`: Sends credentials in a `POST` body.
346
+
- If `IsCredentialsInHeaders: true`: sends a basic authentication header with `username:password`.
347
+
- If `IsCredentialsInHeaders: false`: sends credentials in a `POST` body.
348
348
349
349
2. Extract the token by using `JwtTokenJsonPath` or from the response header.
350
350
@@ -353,9 +353,9 @@ Follow this authentication flow:
353
353
> [!NOTE]
354
354
> Limitations
355
355
>
356
-
> - Requires username and password authentication for token acquisition.
357
-
> - Doesn't support API key-based token requests.
358
-
> -Custom header authentication (without username and password) isn't supported.
356
+
> - Requires username and password authentication for token acquisition
357
+
> - Doesn't support API key-based token requests
358
+
> -Doesn't support custom header authentication (without username and password)
359
359
360
360
## Request configuration
361
361
@@ -373,10 +373,10 @@ The request section defines how the CCF data connector sends requests to your da
373
373
|`TimeoutInSeconds`|| Integer (1...180) | This field defines the request timeout in seconds. The default value is `20`. |
374
374
|`IsPostPayloadJson`|| Boolean | This field determines whether the `POST` payload is in JSON format. The default value is `false`. |
375
375
|`Headers`|| Object | This field includes key/value pairs that define the request headers. |
376
-
|`QueryParameters`|| Object | This field includes Key/value pairs that define the request query parameters. |
376
+
|`QueryParameters`|| Object | This field includes key/value pairs that define the request query parameters. |
377
377
|`StartTimeAttributeName`| True when the `EndTimeAttributeName` value is set. | String | This field defines the query parameter name for the query start time. For more, go to [`StartTimeAttributeName` example](#starttimeattributename-example). |
378
378
|`EndTimeAttributeName`| True when `StartTimeAttributeName` is set. | String | This field defines the query parameter name for query end time. |
379
-
|`QueryTimeIntervalAttributeName`|| String | This field is used if the endpoint requires a specialized format for querying the data on a time frame. Use this property with the `QueryTimeIntervalPrepend` and the `QueryTimeIntervalDelimiter` parameters. For more, go to [`QueryTimeIntervalAttributeName` example](#querytimeintervalattributename-example). |
379
+
|`QueryTimeIntervalAttributeName`|| String | This field is used if the endpoint requires a specialized format for querying the data on a time frame. Use this property with the `QueryTimeIntervalPrepend` and `QueryTimeIntervalDelimiter` parameters. For more, go to [`QueryTimeIntervalAttributeName` example](#querytimeintervalattributename-example). |
380
380
|`QueryTimeIntervalPrepend`| True when `QueryTimeIntervalAttributeName` is set. | String | Reference `QueryTimeIntervalAttributeName`. |
381
381
|`QueryTimeIntervalDelimiter`| True when `QueryTimeIntervalAttributeName` is set. | String | Reference `QueryTimeIntervalAttributeName`. |
382
382
|`QueryParametersTemplate`|| String | This field references the query template to use when passing parameters in advanced scenarios.<br><br>For example: `"queryParametersTemplate": "{'cid': 1234567, 'cmd': 'reporting', 'format': 'siem', 'data': { 'from': '{_QueryWindowStartTime}', 'to': '{_QueryWindowEndTime}'}, '{_APIKeyName}': '{_APIKey}'}"`. |
@@ -636,7 +636,7 @@ Here are some examples:
636
636
|`PageSize`| False | Integer | The number of events per page. |
637
637
|`PageSizeParameterName`| False | String | The query parameter name for the page size. |
638
638
|`NextPageUrl`| False | String | Field that's used only if the connector is for the Coralogix API. |
639
-
|`NextPageUrlQueryParameters`| False | Object key/value pairs that add a custom query parameter to each request for the next page.|
639
+
|`NextPageUrlQueryParameters`| False | Object key/value pairs that add a custom query parameter to each request for the next page |
640
640
|`NextPageParaName`| False | String | The next page name in the request. |
641
641
|`HasNextFlagJsonPath`| False | String | The path to the `HasNextPage` flag attribute. |
642
642
|`NextPageRequestHeader`| False | String | The next page header name in the request. |
@@ -753,7 +753,7 @@ Example:
753
753
|----|----|----|----|
754
754
|`DataCollectionEndpoint`| True | String | Data collection endpoint (DCE). For example: `https://example.ingest.monitor.azure.com`. |
755
755
|`DataCollectionRuleImmutableId`| True | String | The DCR immutable ID. Find it by viewing the DCR creation response or by using the [DCR API](/rest/api/monitor/data-collection-rules/get). |
756
-
|`StreamName`| True | String | This value is the `streamDeclaration` defined in the DCR. The prefix must begin with `Custom-`). |
756
+
|`StreamName`| True | String | This value is the `streamDeclaration` defined in the DCR. The prefix must begin with `Custom-`. |
0 commit comments