Managing Client Applications

Note:

Starting with OHIP Portal version 25.3.1, newly created clients are in a human-readable format '<chain><enterprise><environment><clientName>' rather than a GUID (for example, 'a995b6b2-c983-11ee-8c2e-0242ac110002'). This makes it easier to see who made changes when hotels look in audit logs. The clientName is the same as the clientId to help customers auditing records in OCIM.

With OCIM, you can create multiple clients for different integration needs. This is aimed at providing enhanced security as each integration can have its own client based authentication. Please note this feature is available only for OCIM enabled customers. Partners will continue to have a single client application for a given customer environment.  The following sections explain how to manage client applications in a customer environment.

A default client is already created and can be used for all integrations if that is the customer’s preference.

Searching Client Applications

To find the client applications associated with an environment:

1. From the Developer Portal, click Environments at the top of the page.

2. Click the View Details link for the environment you want to view.

3. This will list all the client applications that have been created for the environment.

4. Search for a given client by Client ID or Client Name in the search bar to find a client.

Adding New Client Applications

To add a new client application:

1. From the Developer Portal, click Environments at the top of the page.

2. Click the View Details link for the environment you want to view.

3. Click the Add Client button.

4. Provide the name of the client. This name is unique across all the clients created with the enterprise.

5. Click Next.

6. Search for and select the properties you wish to assign to the client.

7. Click Next.

8. Review the Summary and then click Add.

9. Once the status of the client is in Approved state, the client is ready for integration

Cloning Client Applications

To clone a client applications associated with an environment:

1. From the Developer Portal, click Environments at the top of the page.

2. Click the View Details link for the environment you want to view.

3. Search for the client by Client ID or Client Name in the search bar to find a client.

4. Click the ellipsis button under the Actions column.

5. Click Clone.

6. Enter a new name for the client.

7. Click the Clone button.

   This clones the configuration of the existing client into the new client.

Note:

The Client ID and secret are regenerated and must be copied for the new client. See ‘Issuing Client Secrets’ above for more about managing the client secret associated with the client application.

Deleting Client Applications

To delete a client application associated with an environment:

1. From the Developer Portal, click Environments at the top of the page.

2. Click the View Details link for the environment you want to view.

3. Search for the client by Client ID or Client Name in the search bar to find a client

4. Click on the ellipsis button under the Actions column

5. Click the Delete button.

   This will delete all the configurations for the client

Note:

All existing integrations using the client must be updated with another valid client application.

Managing Client Applications

To change the properties a client applications may access:

1. From the Developer Portal, click Environments at the top of the page.
2. Click the View Details link for the environment you want to view.
3. Search for the client by Client ID or Client Name in the search bar.
4. Click the ellipsis button under the Actions column.
5. Click Manage.
6. In the Assigned Details section, click Edit.
7. Select the new list of hotels the client application may access and then click Update.