Connect to Cloudaware CMDB API using External Client App with OAuth 2.0 Client Credentials Flow

This guide explains how to configure an External Client App using OAuth 2.0 Client Credentials Flow for Cloudaware CMDB API access.

Prerequisites

Required Cloudaware User Profile permissions:

• View all External Client Apps

• View all External Client App, view their settings, and edit their policies

• Create, edit, and delete External Client Apps

Contact your dedicated technical account manager or tam@cloudaware.com to enable the required permissions. Once the permissions are is enabled, proceed with the setup.

Set up the app

1. Log in to Cloudaware → Setup:

2. In a Quick Find bar, type External Client Apps and select 'External Client App Manager' under Apps:

3. Click New External Client App:

4. Specify a name and a contact email for the app. The API name will be auto-populated. Leave Distribution State as 'Local':

5. Collapse the Basic Information section, expand the ‘API (Enable OAuth Settings)’ section and check the box for 'Enable OAuth':

6. Use http://localhost:1717/OauthRedirect as the Callback URL. Select the following OAuth Scopes:

• Manage user data via APIs (api)

• Perform requests at any time (refresh_token, offline_access)

7. Scroll down, check the box for 'Enable Client Credentials Flow' in the Flow Enablement section. Click OK in the popup window:

8. Uncheck the check box 'Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows' in the Security section unless it is required on your end:

9. Click Create. Ensure that the App has the 'Enabled' status:

Click Edit in the Policies section.

10. Expand the OAuth Policies section. Check the box for 'Enable Client Credentials Flow' and specify the username of a desired Cloudaware user.

This user is considered to be a 'running' user of the app. The API will respect the permissions of the specified user while processing the requests. 

11. Click Save. Allow some time for the app to update or manually refresh the page. Click the button Consumer Key and Secret that becomes available in the section 'OAuth Settings':

12. You will be redirected to an identity verification page. Enter the code sent to the app's contact email to view and copy the the Client ID (Consumer Key) and Client Secret (Consumer Secret).