To install the SOAP Web Service, you must provide a server on which the following software is already installed:
Following versions are supported:
Microsoft .NET Framework Version 4.5.2 or later
|
NOTE: Microsoft .NET Framework version 4.6 is not supported. |
The user account that the Internet Information Service runs under, needs write access (MODIFY) to the installation directory.
|
IMPORTANT: Start the SOAP Web Service installation locally on the server. |
To install the SOAP Web Service
Setting | Description | ||
---|---|---|---|
Application name | Name used as application name, as in the title bar of the browser, for example. | ||
Target in IIS | Internet Information Services web page on which to install the application. | ||
Enforce SSL | Specifies whether insecure websites are available for installation. If the option is set, only sites secured by SSL can be used for installing. This setting is the default value. If this option is not set, insecure websites can be used for installing. | ||
URL |
The application's Uniform Resource Locator (URL). | ||
Install dedicated application pool |
Specifies whether an application pool is installed for each application. This allows applications to be set up independently of one another. If this option is set, each application is installed in its own application pool. | ||
Application pool |
The application pool to use. This can only be entered if the option Install dedicated application pool is not set. The application pool is formatted with the following syntax, if the default value "DefaultAppPool" is used. <application name>_POOL | ||
Identity |
Permissions for executing an application pool. A default identity or a user defined user account can be used. The user account is formatted with the following syntax, if the default value "ApplicationPoolIdentity" is used. IIS APPPOOL\<application name>_POOL If you want to authorize another user, click ... next to the text box and enter the user and password. | ||
Web Authentication |
Specifies the type for authentication against the web application. You have the following options:
| ||
Database authentication |
Specifies the type for authentication against the One Identity Manager database. You have the following options:
|
The user account is used to add or replace files in the application directory.
|
NOTE: The following permissions are required for automatic updating:
|
The Web Installer generates the web application and the corresponding configuration files (web.config) for each folder.
Click Finish on the last page to end the program.
The SOAP Web Service configuration is found in the XML file Web.config in the installation directory. You can use any text editor to edit this file.
Section | Option | Permitted Values | Meaning | ||||||
---|---|---|---|---|---|---|---|---|---|
connectionString | Database connection parameter. | ||||||||
runtimedirs | key="Cache" | value = "<path>" |
Directory for storing the cache directory. Default: value="C:\inetpub\wwwroot\<web service name>\App_Data\Cache\DB" | ||||||
key="AssemblyCache" | value = "<path>" |
Directory for storing the cache directory. Default: value="C:\inetpub\wwwroot\<web service name>\App_Data\Cache\Assemblies" | |||||||
settings | key="timeout" | value="<time>" |
Timeout for connections in the application pool. Default: value="00:05:00" | ||||||
key="maxconnectionlifetime" | value="<time>" |
Maximum length of time to maintain the connections. After this time limit has expired, all the connections are closed even if the timeout has not expired yet. Default: value="00:05:00" | |||||||
key="usepropertybag" | value = "True"
value = "False" |
Specifies whether a property bag is used. A property bag is used in order to maintain a particular fill order when object properties are populated.
Default: value="True" | |||||||
key="ignoreinvisiblevalues" | value = "True"
value = "False" |
Specifies whether values that the user is not permitted to see are not returned.
Default: value="True" | |||||||
key = logdirectory | value = "<path>" |
Log directory. Default: value = "C:\inetpub\wwwroot\<web service name>\App_Data\Logs | |||||||
|
key = allowwebservicemethods |
value = "List of methods" |
semicolon delimited list of permitted web service methods. | ||||||
|
key = allowfunctions |
value = "List of functions" |
List of the permitted functions for each CallFunction method. If no other function is given, all functions are permitted. |
The SOAP Web Service can be reached over a browser under:
http://<server>/<application name>
https://<server>/<application name>
|
TIP: You can open the web server's status display in Job Queue Info. Select the menu item View | Server state in the Job Queue Info and display the web server's state on the Web servers tab by using Open in browser in the context menu. |
In addition, API documentation is available here.
© 2023 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy