Reverse Proxy Authentication Configuration REST API
Use to manage a reverse proxy authentication configuration. These endpoints require the System Administrator role or the Edit System Configuration and Users permission.
GET a Reverse Proxy Authentication Configuration
To get the reverse proxy authentication configuration you can make a GET request to the following path:
GET /api/v2/config/reverseProxyAuthentication
curl -u admin:admin123 http://localhost:8070/api/v2/config/reverseProxyAuthentication
Returns 'Reverse proxy authentication not configured' when not set.
PUT a Reverse Proxy Authentication Configuration
To set the reverse proxy authentication configuration you can make a PUT request to the following path:
PUT /api/v2/config/reverseProxyAuthentication
{
"enabled": true,
"usernameHeader": "MY_USERNAME_HEADER",
"csrfProtectionDisabled": true,
"logoutUrl": "http://localhost/logout/index.html"
}Property not set use the default values from the table below.
curl -X PUT -u admin:admin123 -H "Content-Type: application/json" -d "{\"enabled\": true, \"usernameHeader\": \"MY_USERNAME_HEADER\", \"csrfProtectionDisabled\": true, \"logoutUrl\": \"http://localhost/logout/index.html\"}" "http://localhost:8070/api/v2/config/reverseProxyAuthentication"Property | Default Value | Description |
|---|---|---|
| false | Whether or not reverse proxy authentication is enabled. |
| REMOTE_USER | The name of the HTTP request header field that carries the username. |
| false | Whether or not Cross-Site Request Forgery (CSRF) protection is enabled. Used for backward compatibility with old client plugins. |
| null | The redirect URL when a user requests logout. For |
DELETE a Reverse Proxy Authentication Configuration
To delete the reverse proxy authentication configuration you can make a DELETE request to the following path:
DELETE /api/v2/config/reverseProxyAuthentication
Below is an example request to a local IQ Server using the built-in administrator account and the cURL tool:
curl -X DELETE -u admin:admin123 http://localhost:8070/api/v2/config/reverseProxyAuthentication