Proxy Properties
- 14 Nov 2022
-
DarkLight
-
PDF
Proxy Properties
- Updated on 14 Nov 2022
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Definition
All proxy properties are contained within the proxy object in the IAP Service Instance Configuration for the adapter. These tell the adapter libraries how to handle requests to the other system when there is a proxy that we have to go through in order to get to the other system.
Property | Type | Required | Description |
---|---|---|---|
enabled |
boolean | Yes | Determines whether there is a proxy between Itential and the other system. |
host |
string | Yes (if enabled) | The host information for the proxy server. |
port |
integer | Yes (if enabled) | The port information for the proxy server. |
protocol |
enum | No -> http | The protocol to use for the proxy. The following protocols are supported: HTTP, HTTPS, Socks4 & Socks5 |
username |
string | No | Provide user identification for proxy authenication. |
password |
string | No | Provide password for proxy authenication. |
Example Scenario
- The system is accessed through a Proxy Server.
- The proxy server is at: https://myproxy.xyz.com:443
- The proxy requires authentication. Username - Itential and Passowrd - letmein have been set up for authenticating to the proxy server.
IAP Service Instance Configuration Properties for the Adapter
"proxy": {
"enabled": true,
"host": "myproxy.xyz.com",
"port": 443,
"protocol": "https",
"username": "Itential",
"password": "letmein"
},
Was this article helpful?