Retrieve Groups from OpenText Directory Services

This section describes how to retrieve user and group information from OpenText Directory Services (OTDS).

To retrieve users and groups from OTDS

  1. Create an OAuth application in OTDS, and ensure you have the following information:

    • The client ID and secret for the new OAuth application.
    • The user name and password of an administrative user with read access to all users and groups.
  2. Run the OAuth configuration tool that is supplied with OmniGroupServer.

    1. Open the OAuth tool configuration file, oauth_tool.cfg, in a text editor.
    2. In the [Default] section, set any SSL or proxy settings that are required to access OTDS.

      SSLMethod The version of SSL/TLS to use.
      ProxyHost The host name or IP address of the proxy server to use.
      ProxyPort The port of the proxy server to use.

      For example:

      SSLMethod=NEGOTIATE
      
    3. In the [OTDS] section, set the following parameters:

      TokenUrl Replace the placeholder {OTDS-host} with the hostname of your OTDS instance.
      AppKey The application (client) ID that was provided when you created the OAuth application.
      AppSecret The application (client) secret that was provided when you created the OAuth application.
      CustomValue0 The user name of an administrative user with read access to all users and groups.
      CustomValue1 The password of the administrative user.
    4. Open a command-line window and run the following command:

      oauth_tool.exe oauth_tool.cfg OTDS

      The OAuth configuration tool creates the files oauth.cfg and oauth2_sites.bin. When you configure OmniGroupServer in a later step, you will import the parameters from oauth.cfg into your task configuration.

  3. Open the OmniGroupServer configuration file.
  4. In the [Repositories] section, create a new repository. For example:

    [Repositories]
    Number=1
    0=OTDS
    
    [OTDS]
  5. Include the OAuth configuration parameters necessary to authenticate with OTDS. For example:

    [OTDS] < "oauth.cfg" [OAUTH]
  6. Set the following configuration parameters:

    GroupServerLibrary The library file that allows the group server to access the repository. Use the library ogs_otds.
    OTDSRestApiUrl The base URL of the OpenText Directory Services (OTDS) REST API.
    SSLMethod The SSL/TLS version to use.

    For example:

    [OTDS] < "oauth.cfg" [OAUTH]
    GroupServerLibrary=ogs_otds
    OTDSRestApiUrl=https://otds.example.com/otdsws/rest/
    SSLMethod=negotiate

    For a complete list of configuration parameters that you can use, refer to the OmniGroupServer Reference.

  7. Save and close the OmniGroupServer configuration file.