Linking an IBMid to an IBM Sterling Order Management user

After logging into IBM® Sterling Order Management for the first time using an IBMid, you must link the IBMid to your IBM Sterling Order Management user email ID.

Throughout this topic, the following naming conventions are used when referring to user IDs:
  • IBMid – IBMid account of the user.
  • OMS user ID - User ID defined in IBM Sterling Order Management for the user. This user ID determines the permissions a user has in the IBM Sterling Order Management applications.

Guidelines for using an IBMid in IBM Sterling Order Management

  • If the user who owns admin user privileges and is associated to an IBMid is no longer available, you must create a new user with admin privileges using REST API calls.
  • Ensure that there is unique mapping between IBMid users and OMS users. A single IBMid cannot be associated with multiple users.
  • To remove the association between the IBMid and the IBM Sterling Order Management user, you must remove the user from the IBM Sterling Order Management system using either the Applications Manager UI or by calling the deleteUserHierarchy API.
  • Ensure that the authentication type is set to BASIC for the HTTP REST XAPI Tester. For more information about how to set up the HTTP REST XAPI Tester, see Setting up HTTP REST XAPI Tester.

Linking an OMS user with an IBMid account

You must provide an email ID for any new users you create in the IBM Sterling Order Management system. This email ID is used to link the OMS user with an IBMid account. Therefore, the email ID used when creating an OMS user and an IBMid must be the same. IBM Sterling Order Management user creation can be done using either the Applications Manager UI or by calling the createUserHierarchy API.

The following text demonstrates sample input XML for the createUserHierarchy API:
<User Localecode=“en_US_EST” Username=“user1" Loginid=“user1” Password=“password”>
<ContactPersonInfo EMailID=“abc@xyz.com“/>
</User>

Login flow after an IBMid is linked to an IBM Sterling Order Management user

  1. User accesses the IBM Sterling Order Management application home page.
  2. User is redirected to the IBMid login page.
  3. User enters the IBMid login credentials.
  4. If the login is successful, the user is logged in to IBM Sterling Order Management application as the mapped OMS user ID.
    Important: If the user uses an IBMid that is not linked to any OMS user, the system displays the IBM Sterling Order Management application login screen. The user must then enter OMS user credentials to log in to the IBM Sterling Order Management application. On any subsequent login, the user is automatically logged in to the application's home page.

The following image shows the login flow when an IBMid is linked to an IBM Sterling Order Management user:

Figure 1. Login flow when an IBMid is linked to an IBM Order Management user
Login flow when an IBMid is linked to an IBM Order Management user