Skip to content

Commit 355ec64

Browse files
authored
Minor changes
1 parent 847d6e3 commit 355ec64

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

articles/sentinel/data-connector-connection-rules-reference.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The result of this example is the secret defined from the user input sent in the
143143
}
144144
```
145145

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`.
147147

148148
```json
149149
"auth": {
@@ -153,7 +153,7 @@ This example uses the default values and results in the following header: Author
153153
}
154154
```
155155

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`.
157157

158158
#### OAuth2
159159

@@ -224,7 +224,7 @@ Here's an example of the OAuth2 `client_credentials` grant type:
224224

225225
JSON Web Token (JWT) authentication supports obtaining tokens via username and password credentials and using them for API requests.
226226

227-
##### Basic Example
227+
##### Basic example
228228

229229
```json
230230
"auth": {
@@ -331,9 +331,9 @@ Follow this authentication flow:
331331
| `TokenEndpoint` | True | String | The URL endpoint that's used to obtain the JWT token. |
332332
| `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`. |
333333
| `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`). |
335335
| `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`. |
337337
| `JwtTokenIdentifier` | | String | The identifier used to extract the JWT from a prefixed token string. |
338338
| `QueryParameters` | | Object | The custom query parameters to include when sending the request to the token endpoint. |
339339
| `Headers` | | Object | The custom headers to include when sending the request to the token endpoint. |
@@ -343,8 +343,8 @@ Follow this authentication flow:
343343

344344
1. Send credentials to `TokenEndpoint` to obtain the JWT token.
345345

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.
348348

349349
2. Extract the token by using `JwtTokenJsonPath` or from the response header.
350350

@@ -353,9 +353,9 @@ Follow this authentication flow:
353353
> [!NOTE]
354354
> Limitations
355355
>
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)
359359
360360
## Request configuration
361361

@@ -373,10 +373,10 @@ The request section defines how the CCF data connector sends requests to your da
373373
| `TimeoutInSeconds` | | Integer (1...180) | This field defines the request timeout in seconds. The default value is `20`. |
374374
| `IsPostPayloadJson` | | Boolean | This field determines whether the `POST` payload is in JSON format. The default value is `false`. |
375375
| `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. |
377377
| `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). |
378378
| `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). |
380380
| `QueryTimeIntervalPrepend` | True when `QueryTimeIntervalAttributeName` is set. | String | Reference `QueryTimeIntervalAttributeName`. |
381381
| `QueryTimeIntervalDelimiter` | True when `QueryTimeIntervalAttributeName` is set. | String | Reference `QueryTimeIntervalAttributeName`. |
382382
| `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:
636636
| `PageSize` | False | Integer | The number of events per page. |
637637
| `PageSizeParameterName` | False | String | The query parameter name for the page size. |
638638
| `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 |
640640
| `NextPageParaName` | False | String | The next page name in the request. |
641641
| `HasNextFlagJsonPath` | False | String | The path to the `HasNextPage` flag attribute. |
642642
| `NextPageRequestHeader` | False | String | The next page header name in the request. |
@@ -753,7 +753,7 @@ Example:
753753
|----|----|----|----|
754754
| `DataCollectionEndpoint` | True | String | Data collection endpoint (DCE). For example: `https://example.ingest.monitor.azure.com`. |
755755
| `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-`. |
757757

758758
## Example CCF data connector
759759

0 commit comments

Comments
 (0)