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
+4-15Lines changed: 4 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -310,26 +310,26 @@ JSON Web Token (JWT) authentication supports obtaining tokens via username and p
310
310
311
311
Follow this authentication flow:
312
312
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.
314
314
315
315
- If `IsCredentialsInHeaders: true`: Sends a basic authentication header with `username:password`.
316
316
- If `IsCredentialsInHeaders: false`: Sends credentials in a `POST` body.
317
317
318
318
2. Extract the token by using `JwtTokenJsonPath` or from the response header.
319
319
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".
321
321
322
322
|Field |Required |Type |Description |
323
323
| ---- | ---- | ---- | ---- |
324
324
|`type`| True | String | The type. Must be `JwtToken`|
325
325
|`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`. |
326
326
|`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`. |
327
327
|`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`. |
329
329
|`NoAccessTokenPrepend`| False | Boolean | An access flag that indicates that the token shouldn't prepend anything. |
330
330
|`TokenEndpointHttpMethod`| False | String | The HTTP method for token endpoint. It can be `Get` or `Post`. The default is `Post`. |
331
331
|`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`. |
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
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`. |
@@ -339,17 +339,6 @@ Follow this authentication flow:
339
339
|`Headers`|| Object | The custom headers to include when sending the request to the token endpoint. |
340
340
|`RequestTimeoutInSeconds`|| Integer | The request timeout in seconds. The default value is `100`, with a maximum value of `180`. |
341
341
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.
0 commit comments