3.67.1. RestAuthRequestDef Previous topic Parent topic Child topic Next topic

This parameter allows you to define parameters for authentication requests sent via HTTP REST API.
You can specify any number of RestAuthRequestDef parameters, one for each parameter sent to the server. The general format is:
RestAuthRequestDef authtparam,attributename[,type[,formatted]]
  • authparam is the REST parameter name
  • attributename defines the value for authparam. The value may be fetched from the current request, be a value that is subject to special formatting, or a literal value
  • type consists of the word “literal” or the word “request”. If type is empty or “request”, the value is fetched from the current request. If type is "literal", it is added to the HTTP request as it is.
  • formatted indicates that the value specified with attributename is to be subject to special character processing before being used.
Tip
The type and formatted fields are optional. If they are not specified, type defaults to "request" and formatted defaults to not enabled.

Example

The following example adds 3 parameters in the REST API request Radiator sends. Parameter "request_type" is set to literal value "authentication". Parameter "server_name" is set to the hostname of server that Radiator runs on. Value for parameter "username" is copied from the "User-Name" attribute of the currently processed request.
RestAuthRequestDef request_type, authentication, literal
RestAuthRequestDef server_name, %h, literal, formatted
RestAuthRequestDef username, User-Name