PLBWEB_REST_AUTH_REALM Keyword

9.9A

PLBWEB_REST_AUTH_REALM<nn>=<String>

 

This keyword invokes basic authentication identifying the web client user.

 

This keyword is optional and can be placed in the [Environment] section of the PWS configuration INI file.

 

If there is no user/password supplied in the authentication header used to access the PWS REST service, a Http 401 response is sent back to the web client as follows:

WWW-Authenticate: Basic realm=<realm name>

This causes a browser to bring up a username/password dialog and resubmit the Http request providing the user/password entered into the dialog.

Where:

'nn'

The 'nn' that is appended to the PWS keyword name can be a string value from '01' to '99'.

<string>

This is the realm string that is shown in the username/password dialog by the client browser.

Example:

PLBWEB_REST_AUTH_REALM01=PL/B Services

Note:

1.   Using the PL/B RUNTIME method named 'CgiString', the CGI string for the AUTH_TYPE field keyword determines the authentication input data.

2.   The user name sent can be found in the AUTH_USER or REMOTE_USER keyword CGI strings using the RUNTIME 'CgiString' method.

3.   The full base64 username:password string can be found in the AUTH_DATA keyword CGI string using the RUNTIME 'CgiString' method.

See Also: PLBWEBSRV Keywords, Server Command Line