Configure smart card authentication for APIs

To use APIs with smart card authentication, the following changes must be made.

• OTA API:

  When the user attempts to log in, a window appears and the user selects the proper certificate to establish an SSL connection. If the application is not supposed to work in interactive mode or if the user frequently logs in, the user can specify a default certificate.

  To specify the default certificate, in OpenText Application Quality Management go to Help > ALM Tools > Webgate Customization. On the Web Server Settings tab, select the appropriate WebClient certificate mode, and select your default certificate.

  The WebClient certificate modes are explained as follows:

  • Not specify mode – This mode is for backward compatibility with applications developed before external authentication was available. If the certificate is not applied, it works like the Interactive mode.

  • Interactive mode – This mode is for interactive use, where a screen appears if the certificate is not provided or cannot be applied to the connection. To enable this mode, use ITDConnection9:: SetExecutionMode().

  • Non-interactive mode – This mode is for non-interactive use, where an error code is returned if the certificate is not provided or cannot be applied to the connection. To enable this mode, use ITDConnection9:: SetExecutionMode().

• REST API:

  Note: The REST API is a technical preview.

  • Web browser extension (REST clients) – The web browser establishes the SSL connection. When attempting to connect, a certificate selection window appears. After the certificate is applied, REST API continues as usual.

  • Non browser REST Clients – The REST client establishes the SSL connection, after which REST API continues as usual.