Chat now with support
Chat mit Support

Identity Manager 9.1.1 - API Development Guide

install-apiserver

Installs an API Server on the local Internet Information Services (IIS).

Parameters

Login parameter:

  • /conn <database connection>: Specifies the database you want to connect to.

  • /dialog <dialog authentication>: Specifies the dialog authentication.

Required parameters:

  • /app <application name>: Specifies which name is used for the application (for example, in the brower's titlebar).

  • /sessioncert <certificate thumbprint>: Specifies which (installed) certificate is used for creating and verifying session tokens.

    TIP: For example, to obtain a certificate thumbprint, you can use the Manage computer certificates Windows function and find the thumbprint through the certificate's detailed information.

Optional parameter:

  • /conndialog <option>: Specifies whether a login window is displayed for the database connection. The following options are possible:

    • off: The login window is not shown. If the database is not connected, an attempt is made to establish a connection.

    • show: The login window is shown (even is a database is already connected) and the new connection replaces the old one.

    • fallback (default): The current database connection is used. If the database is not connected, an attempt is made to establish a connection.

  • -u: Allows insecure HTTP connections to the API Server website. By default, the API Server website can only be opened over an encrypted connection.

  • /site <site name>: Specifies the website on the IIS under which the web application will be installed. If you do not enter anything, the website is found automatically (normally Default website).

  • /searchservice <URL>: Specifies the application server's URL that the search service you want to use is hosted on.

    NOTE: If you would like to use the full text search, then you must specify an application server. You can enter the application server in the configuration file at a later date.

Related topics

push-files

Saves files that you have changed locally back to the database.

Parameters

Login parameter:

  • /conn <database connection>: Specifies the database you want to connect to.

  • /dialog <dialog authentication>: Specifies the dialog authentication.

Required parameters:

  • /targets <target1;target2;...>: Specifies which machine roles you want to use.

Optional parameter:

  • /conndialog <option>: Specifies whether a login window is displayed for the database connection. The following options are possible:

    • off: The login window is not shown. If the database is not connected, an attempt is made to establish a connection.

    • show: The login window is shown (even is a database is already connected) and the new connection replaces the old one.

    • fallback (default): The current database connection is used. If the database is not connected, an attempt is made to establish a connection.

  • /factory <target system>: Specifies the target system for the connection. Enter this parameter if you want to establish a connection to the application server. Example: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

  • /workspace <folder path>: Specifies the working directory where the files are located that have been modified and are now to be stored in the database. If you do not enter anything here, the current directory is used.

  • /tag <uid>: Specifies the change label to use to book the changes. For more information about change labels, see the One Identity Manager Operational Guide.

  • /add <file1;file2;...>: Specifies which new database files are added. Use relative paths.

  • /del <file1;file2;...>: Specifies which database files are deleted. Use relative paths.

  • -C: Prevents the saving of changed files and saves only new files, and deletes files from the database.

Related topics

repl

Starts the ImxClient command line tool in REPL mode.

In this mode, the following actions are performed in an infinite loop:

  • Read commands from stdin.

  • Forward commands to the relevant plugin.

  • Output the results of processing to stdout.

Related topics

run-apiserver

Starts or stops a self-hosted API Server.

This command requires a database connection.

Parameters

Login parameter:

  • /conn <database connection>: Specifies the database you want to connect to.

  • /dialog <dialog authentication>: Specifies the dialog authentication.

Optional parameter:

  • /conndialog <option>: Specifies whether a login window is displayed for the database connection. The following options are possible:

    • off: The login window is not shown. If the database is not connected, an attempt is made to establish a connection.

    • show: The login window is shown (even is a database is already connected) and the new connection replaces the old one.

    • fallback (default): The current database connection is used. If the database is not connected, an attempt is made to establish a connection.

  • /factory <target system>: Specifies the target system for the connection. Enter this parameter if you want to establish a connection to the application server. Example: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

  • -S: Stops the API Server.

  • /baseaddress <base URL with port>: Specifies the base URL and port of the web application where the API Server accepts connections.

    Example 

    /baseaddress http://localhost:8184

  • /baseurl <root URL>: Specifies the web application's URL.

    Example 

    /baseaddress http://localhost

  • /plugin <file name 1, file name 2>: Loads additional plug-ins from the given files.

  • /htmldir <directory>: Specifies the directory to use to load additional HTML application files and plug-in. This setting is intended for development scenarios.

    Example 

    /htmldir C:example\imxweb\cpl

    The cpl plug-in is loaded from the C:example\imxweb\cpl folder instead of the default source.

  • -T: Queries the status of the current API Server.

  • -B: Locks the console.

Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen