Skip to content

Commit 4058fcc

Browse files
committed
Learn Editor: Update data-connector-connection-rules-reference.md
1 parent ebddfa9 commit 4058fcc

1 file changed

Lines changed: 4 additions & 15 deletions

File tree

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

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -310,26 +310,26 @@ JSON Web Token (JWT) authentication supports obtaining tokens via username and p
310310

311311
Follow this authentication flow:
312312

313-
1. Send credentials to `TokenEndpoint` to obtain JWT token.
313+
1. Send credentials to `TokenEndpoint` to obtain JWT token, when using `userName` and `password`, `IsCredentialsInHeaders` is used to determine where to put credentials in the request.
314314

315315
- If `IsCredentialsInHeaders: true`: Sends a basic authentication header with `username:password`.
316316
- If `IsCredentialsInHeaders: false`: Sends credentials in a `POST` body.
317317

318318
2. Extract the token by using `JwtTokenJsonPath` or from the response header.
319319

320-
3. Use the token in subsequent API requests with the `ApiKeyName` header.
320+
3. The Authorization header for the JWT tokens is a constant and will always be "Authorization".
321321

322322
|Field |Required |Type |Description |
323323
| ---- | ---- | ---- | ---- |
324324
| `type` | True | String | The type. Must be `JwtToken` |
325325
| `userName` | True (if `userToken` isn't used) | Object | The key/value pair for the `userName` credential. If `userName` and `password` are sent in the header request, specify the `value` property with the username. If `userName` and `password` are sent in the body request, specify `Key` and `Value`. |
326326
| `password` | True (if `userToken` isn't used) | Object | The key/value pair for the password credential. If `userName` and `password` are sent in the header request, specify the `value` property with the `userName`. If `userName` and `password` are sent in the body request, specify `Key` and `Value`. |
327327
| `userToken` | True (if `userName` isn't used) | String | The user token generated by the client to get the system token for authentication. |
328-
| `UserTokenPrepend` | False | String | The value that indicates whether to prepend text before the token. Example: `Bearer`. |
328+
| `UserTokenPrepend` | False | String | The value that indicates whether to prepend text before the token. Default: `Bearer`. |
329329
| `NoAccessTokenPrepend` | False | Boolean | An access flag that indicates that the token shouldn't prepend anything. |
330330
| `TokenEndpointHttpMethod` | False | String | The HTTP method for token endpoint. It can be `Get` or `Post`. The default is `Post`. |
331331
| `TokenEndpoint` | True | String | The URL endpoint that's used to obtain the JWT token. |
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`. |
332+
| `IsCredentialsInHeaders` | | Boolean | The value that indicates whether to send credentials as a basic authentication header (`true`) versus a `POST` body (`false`), ignored when using `userToken`. 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`. |
334334
| `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`. |
@@ -339,17 +339,6 @@ Follow this authentication flow:
339339
| `Headers` | | Object | The custom headers to include when sending the request to the token endpoint. |
340340
| `RequestTimeoutInSeconds` | | Integer | The request timeout in seconds. The default value is `100`, with a maximum value of `180`. |
341341

342-
Follow this authentication flow:
343-
344-
1. Send credentials to `TokenEndpoint` to obtain the JWT token.
345-
346-
- If `IsCredentialsInHeaders: true`: sends a basic authentication header with `username:password`.
347-
- If `IsCredentialsInHeaders: false`: sends credentials in a `POST` body.
348-
349-
2. Extract the token by using `JwtTokenJsonPath` or from the response header.
350-
351-
3. Use the token in subsequent API requests with the `ApiKeyName` header.
352-
353342
> [!NOTE]
354343
> Limitations
355344
>

0 commit comments

Comments
 (0)