Oauth-credentials (Section)#
Path: /facilities/http/client/oauth-credentials
This enables the HTTP client to use OAuth 2.0 client credentials flow to obtain an access token for endpoint access
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| client-id | string (length: 1..9223372036854775807) | required | - | The client id to use when obtaining an OAuth 2.0 access token |
| client-secret | string (length: 1..9223372036854775807) | required | - | The client secret to use when obtaining an OAuth 2.0 access token |
| send-client-credentials-in-authorization-header | boolean | optional | false | Passes the OAuth credentials in the Authorization header instead of POST body |
| token-expiration-time-skew | uint16 | optional | 10 | Time skew when considering whether a token should be considered to be expired (e.g. if 10 seconds and the token expires in 9 seconds, the token will be considered expired) |
| scope | multi-value string | optional | - | Scopes to request when requesting a new access token from the OAuth 2.0 client |
| token-endpoint | string | required | - | The complete url to the token endpoint of the OAuth server used to retrieve the access token |
Subsections#
| Name | Type | Description |
|---|---|---|
| inner-client-or-legacy-settings | OneOf |