HTTP bearer authentication definitions
- Wolfgang Granzer
The HTTP interface is used to send and receive data and information from HTTP server. If the remote HTTP server requires bearer authentication, the required configuration for bearer authentication can be specified here.
File location
<WorkspaceDirectory>\DataFiles\xio.HTTP.BearerDefinitions.dat
Â
Changes within this definition file are taking effect immediately. No server restart is required.
Â
Col# | Parameter | Description | Scope | Unit | Mandatory / default value |
|---|---|---|---|---|---|
1 | Name | it is the key that identifies the bearer definition. The name can freely be chosen but has to be unique. | string | None | mandatory |
2 | Bearer method | if static is used, the bearer token is a static one that has to be defined in "Bearer Token or Refresh Url". If dynamic is chosen, the bearer token has to be fetched from a HTTP server periodically. | Static, Dynamic | None | Static |
3 | Bearer token or refresh URL | if static is used, the bearer token has to be defined here. If dynamic is chosen, the HTTP server URL from which the bearer token can be retrieved must be defined here. | string | None | mandatory |
The following parameters are only required, if "dynamic" is chosen as bearer method:
Col# | Parameter | Description | Scope | Unit | Mandatory / default value |
|---|---|---|---|---|---|
4 | Refresh method | the HTTP request method for retrieving the token. | POST, PUT, GET | None | POST |
5 | Refresh interval | the interval in seconds for refreshing the bearer token. | 1 – 65535 | seconds | 60 |
6 | Request resource | the resource that is used for requesting the bearer token. It has to match the name that is used in the HTTP resource definition. | Reference to HTTP resource definition | None | mandatory |
7 | Request parameters | A comma-separated list of parameters that are used to replace the placeholders within the request resource ({0}, {1}, ...). | string | None | empty |
8 | Response Resource | the resource that is used for extracting the token from the response. It has to match the name that is used in the HTTP resource definition. | Reference to HTTP resource definition | None | mandatory |
9 | Response parameters | A comma-separated list of parameters that are used to replace the placeholders within the request resource ({0}, {1}, ...). | string | None | empty |
10 | Authentication method | The authentication method (None, Basic or Digest) if required by the HTTP server. | None, Basic, Digest | None | None |
11 | Authentication user | Username for Basic or Digest HTTP authentication if required by the HTTP server. | string | None | empty |
12 | Authentication password | Password for Basic or Digest HTTP authentication if required by the HTTP server. If empty, no HTTP authentication is used. | string | None | empty |
13 | Additional HTTP headers | A list of additional HTTP headers which is included in each HTTP request, e.g. for authentication purposes. Additional headers must have the following form: "<key1>: <value1>\r\n<key2>: <value2>\r\n<key3>: <value3>..." | string | None | empty |
14 | Response Refresh Resource | If the bearer authentication uses a dynamic refresh token, the resource to extract this refresh token can be specified here. | string | None | empty |
Â