Installing and updating an API Server
The API Server deploys the Web Portal, the Password Reset Portal, the Administration Portal as well as the Operations Support Web Portal and your HTML5 web applications. It also provides an API.
You can install the API Server with help from the Web Installer or the ImxClient command line program (the install-apiserver command). Read through the following sections for instructions on how to install the API Server on a Web Installer using the Windows Server and set it up with the default configuration. For more information about installing with the ImxClient command line program, see the One Identity Manager API Development Guide.
Before installation ensure that the minimum hardware and software prerequisites are fulfilled on the server.
Detailed information about this topic
Installing the API Server
IMPORTANT: Start the API Server installation locally on the server.
To install the API Server
-
Launch autorun.exe from the root directory of the One Identity Manager installation medium.
-
On the installation wizard's home page, perform the following actions:
-
Click Installation.
-
In the Web-based components pane, click Install.
This starts the Web Installer.
-
On the start page of the Web Installer, click Install API Server and click Next.
-
On the Database connection page, do the following.
TIP: One Identity recommend establishing a connection via an application server.
-
To use an existing connection to the One Identity Manager database, select it in the Select a database connection drop-down.
- OR -
To create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.
-
Under Authentication method, specify the method and login data you would like to use.
-
On the Installation source page in the Installation source pane, specify where to find the installation data.
-
To retrieve the installation data from the database, activate the Database option.
-
to retrieve the installation data from the installation media (for example, from the hard drive), activate the File system option and enter the path.
-
On the Installation source page, in the Additional connections section, enter any additional information for authentication. This displays the number of connections that can be configured.
-
To configure additional authentication data, click .
-
In the Authentication data dialog, select the project you want to authenticate and enter the authentication data.
NOTE: You can also configure the authentication data for optional projects at a later date. You must enter authentication data if the project is marked in red.
-
Multi-factor authentication with OneLogin (OneLogin): Multi-factor authentication with OneLogin can be used for specific security-critical actions in One Identity Manager. For more information, see the One Identity Manager Web Application Configuration Guide.
Enter the authentication data for logging in to the OneLogin domain.
-
Connection string: Connection string for logging in to the OneLogin domain.
Syntax: Domain=<domain>;ClientId=<clientid>;ClientSecret=<clientSecret>
- OR -
-
Domain: Enter the DNS name of the synchronized OneLogin domain.
Example: <your domain>.onelogin.com
-
Client ID: Enter the client ID with which the application is registered in OneLogin. You obtain the client ID when you register your application with OneLogin.
-
Client secret: Enter the security token for the OneLogin application. You obtain the client secret when you register your application with OneLogin.
-
Authentication for self-registration of new users (sub:register): For self-registration of new users in the Password Reset Portal, a user is required with which the new user accounts are created.
NOTE: It is recommended to use the IdentityRegistration system user. This system user has the specified permissions required for self-registration of new users in the Password Reset Portal.
If you have your own system user, ensure that it has the necessary permissions. For more information about system users and permissions, see the One Identity Manager Authorization and Authentication Guide.
-
If you use the IdentityRegistration system user, enter a password for the system user.
-
If you want to use your own system user, under Authentication method, select the authentication module for logging in. Depending on the authentication module, other data may be required, such as user and password. For more information about One Identity Manager authentication modules, see the One Identity Manager Authorization and Authentication Guide.
-
To test the data, click Test connection.
-
To accept the data, click OK.
-
Configure the following settings on the Select setup target page.
Table 28: Settings for the installation target
Application name |
Enter the name to use in the browser as the application name. |
Target in IIS |
Select the website on the Internet Information Services where the application is installed. |
Enforce SSL |
Specifies whether secure or insecure websites are available to install.
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 |
Enter the application's URL. |
Install dedicated application pool |
Enable this option if you want to install a separate application pool 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 |
Select the application pool to use. This can only be entered if the Install dedicated application pool option is not set.
If you use the DefaultAppPool default value, the application pool has the following syntax:
<application name>_POOL |
Identity |
Specify the permissions for implementing the application pool. You can use a default identity or a custom user account.
If you use the ApplicationPoolIdentity default value, the user account has the following syntax:
IIS APPPOOL\<application name>_POOL
You can authorize another user by clicking ... next to the box, enabling the option Custom account and entering the user and password. |
Assign file permissions for application pool identity |
Specify whether the identity that the application pool was running with obtains the file permissions. |
Overwrite default IIS request limits |
Specify whether the default IIS values for the URL length, query string length, and content length are overwritten. If the values are not adequate, IIS returns an HTTP 404 error. For more information, see HTTP 404 Error Substatus Codes.
Adjust the values to suit your requests if necessary.
-
Max. URL length [B]: Maximum length if a URL in bytes. The default value is 4096 bytes.
-
Max. query string length [B]: Maximum length of a query string in bytes. The default value is 32768 bytes.
-
Max. content length [B]: Maximum length of content in bytes. The efault value is 30000000 bytes.
NOTE: You can configure these values at a later date. |
Web authentication |
Specify which type of authentication to use against the web application. You have the following options:
-
Windows authentication (single sign-on)
The user is authenticated against the Internet Information Services using their Windows user account and the web application logs in the identity assigned to the user account as role-based. If single sign-on is not possible, the user is diverted to a login page. You can only select this authentication method if Windows authentication is installed.
-
Anonymous
Login is possible without Windows authentication. The user is authenticated against the Internet Information Services and the web application anonymously, and the web application is directed to a login page. |
Database authentication |
NOTE: You can only see this section if you have selected an SQL database connection on the Database connection page.
Specify which type of authentication to use against the One Identity Manager database. You have the following options:
-
Windows authentication
The web application is authenticated against the One Identity Manager database with the same Windows user account that your application pool uses. Login is possible with a user-defined user account or a default identity for the application pool.
-
SQL authentication
Authentication is completed using an SQL login and password. The SQL login used is from the database connection. Use the [...] button to enter a different SQL login, for example, if the application is run with a access level for end users. This access data is saved in the web application configuration as computer specific encrypted. |
-
On the Select application server page, perform the following actions.
NOTE: This page only shown if you have selected a direct database connection.
NOTE: If you would like to use the full-text search, then you must specify an application server.
-
Click Select application server.
-
In the dialog, in the URL field, enter the web address of the application server that is running the search service for full-text search.
-
Click OK.
-
On the Set session token certificate page, select the certificate for creating and checking session tokens.
NOTE: The certificate must have a key length of at least 1024 bits.
-
To use an existing certificate, set the following:
-
Session token certificate: Select the Use existing certificate entry.
-
Select certificate: Select the certificate.
NOTE: It is strongly recommended to use the certificate already in use in other application servers and API Servers.
-
Show invalid certificates too: (Optional) Enable this option to show other certificates.
-
To create a new certificate, set the following:
-
Session token certificate: Select the Create new certificate entry.
-
Certificate issuer: Enter the issuer of the certificate.
-
Key length: Specify the key length for the certificate.
The certificate is entered in the application server's certificate management.
NOTE: It is strongly recommended to export this newly created certificate and use it in other application servers and API Servers as well, so that all these server components have and use the identical session certificate.
-
To create a new certificate file, set the following:
-
Session token certificate: Select the Generate new certificate file entry.
-
Certificate issuer: Enter the issuer of the certificate.
-
Key length: Specify the key length for the certificate.
-
Certificate file: Enter the directory path and name of the certificate file.
The certificate file is stored in the specified directory of the web application.
NOTE: It is strongly recommended to use this newly created certificate in other application servers and API Servers as well, so that all these server components have and use the identical session certificate.
-
On the Assign machine roles page, define the machine roles.
The SCIM Provider machine role is required for the SCIM plug-in in the API Server. For more information about the SCIM plug-in, see the One Identity Manager Configuration Guide.
NOTE: You can configure the SCIM plug-in at a later date.
-
Specify the user account for automatic updating on the Set update credentials page by activating one of the following options:
NOTE: The user account is used to add or replace files in the application directory.
-
Use IIS credentials for update: Set this option to use the user account used by the application pool to run updates.
-
Use other credentials for updates: To use a different user account, set this option. Specify the domain, the user name, and the user password.
-
On the Application token page, enter the application token for the API Server into the input field. The application token is required by the Password Reset Portal.
NOTE: Handle the application token like a password. Once the application is saved in the database, it cannot be displayed in text form again. Make a note of the application token if necessary.
TIP: To use a new token and therefore replace the existing token in the database, activate the option Replace the application token in the database. When doing so, note that the current token will become invalid and every location that uses it must be updated with the new token.
-
Installation progress is displayed on the Setup is running page. After installation is complete, click Next.
-
On the Wizard complete page, click Finish.
-
Close the autorun program.
Displaying an overview of HTML web applications
The API Server deploys the Web Portal, the Password Reset Portal, as well as the Operations Support Web Portal and an Administration Portal.
To access all installed HTML applications
-
In a web browser, open the web address (URL) of your API Server.
http://<server name>/<application name>
https://<server>/<application name>
All HTML applications are displayed in the web application overview. You can launch several web applications from here.
In the Administration Portal, you obtain an overview of the status of the API Server, the configuration, and can view the logs. You can configure the API server and its API projects in the Administration Portal and display the information. For more information, see the One Identity Manager Web Application Configuration Guide.
API Servers for configuring load balancing
An API Server can be configured as part of an application pool and participate in load balancing.
Prerequisites for load balancing
-
All API Servers that participate in load balancing must be configured with the same certificate when they are installed.
With this certificate, all API Servers from the application pool can encrypt and decrypt their data securely. When changing API Servers, another API Server can restore the session so that web application users can work seamlessly. You set the certificate in the Set session token certificate step when you install the API server.
NOTE: This certificate is independent of the certificate used for SSL.
-
For the best possible performance, the load balancing must support session bindings (sticky sessions). All HTTP requests in a session should be routed to the same API Server, because rebuilding a session leads to performance issues.