Updating single sign-on configuration

Single sign-on to Global Mailbox from Sterling B2B Integrator is configured by default when Global Mailbox is installed with Sterling B2B Integrator or on an existing instance of Sterling B2B Integrator. You can update the configuration based on your requirements.

1. Locate the <install_dir>/MailboxUtilities/admin/bin (UNIX/Linux) directory or \<install_dir>\MailboxUtilities\admin\bin (Windows) directory.
   Tip: Replace <install_dir> with the directory where your instance is installed.
2. Type ./appConfigUtility.sh setSSO (Linux® or UNIX) or appConfigUtility.bat setSSO (Windows) in the command line.
3. Enter the following parameters and values to suit your needs, in the format: ./appConfigUtility.sh setSSO <parameter="value"> (Linux or UNIX) and appConfigUtility.bat setSSO <parameter="value"> (Windows).

   --adminUser

   Global Mailbox administrator user. Specifying a value for the adminUser parameter is optional. Utility prompts for value if not provided. The following value is an example for the adminUser parameter:

   --adminUser="userid"

   --adminPassword

   Global Mailbox administrator password. A value for this parameter must be provided if adminUser is specified. The following value is an example for the adminPassword parameter:

   --adminPassword="password"

   --appName

   The name of the application. This name is displayed in the Application field in the user permissions wizard in the Global Mailbox management tool. The appName is ignored if appID is specified. The following value is an example for the appName parameter:

   --appName="application name"

   --dcName

   The name of a data center. Specifying a value for this parameter is optional. If a value is not specified, the name of the local data center where the utility is being run is populated. The following value is an example for the dcName parameter:

   --dcName="DC1"

   --appID

   The unique ID of the application that is generated at application registration time. Specifying a value for the appID parameter is optional. The following value is an example for the appID parameter:

   --appID="application id"

   --url

   The URL of the Sterling B2B Integrator single sign-on REST API. Specifying a value for the url parameter is required. The URL follows the formatting structure in the following example:

   "<scheme>://<host>[:<port>]/<context>"

   The following value is an example of the url parameter:

   --url="https://www.example.com:41470/restwar/restapi/v1.0/authenticate/sso

   --authorizedGroups

   A list of Sterling B2B Integrator group names that have permission to access the Global Mailbox management tool by single sign-on. A group is a collection of user permissions that is specific to a set of Sterling B2B Integrator users. Specifying a value for the --authorizedGroups parameter is required. The following list of groups are valid values for the --authorizedGroups parameter:

   • MAILBOX
   • Deployment
   • Mailbox Administrators
   • Sterling B2B Integrator Admin

   --authorizedGroups="MAILBOX, Deployment"

   --removeURL

   The URL to be removed from the list of URLs already configured for the APIs. Specifying a value for this parameter is optional. This parameter can also be used to modify a URL. To modify a base URL, specify the URL name on the removeURL option and specify its new value on the baseURL option. The following URL is an example for the --removeURL parameter:

   https://host.loc.ustx.ibm.com:99999/api/V1/users