Skip to main content

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​

Contact your dedicated technical account manager or tam@cloudaware.com to enable the required Cloudaware User Profile permissions:

  • View all External Client Apps
  • View all External Client Apps, view their settings, and edit their policies
  • Create, edit, and delete External Client Apps

Once the permissions are enabled, proceed with the setup.

Set Up the App​

  1. Log in to Cloudaware → Setup.

  2. In the Quick Find bar, search for External Client Apps and select External Client App Manager under Apps.

  3. Click New External Client App.

  4. Set a name and a contact email for the app. The API name is auto-populated.

  5. Leave Distribution State as Local.

  6. Collapse Basic Information.

  7. Expand API (Enable OAuth Settings) and check Enable OAuth.

  8. Under App Settings, use http://localhost:1717/OauthRedirect as the callback URL.

  9. Select the following OAuth scopes:

    • Manage user data via APIs (api)
    • Perform requests at any time (refresh_token, offline_access)

  10. Under Flow Enablement, check Enable Client Credentials Flow.

  11. Click OK in the popup window.

  12. Under Security, uncheck Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows unless it is required on your end.

  13. Click Create.

  14. Ensure that the app has the Enabled status.

  15. In the Policies tab, click Edit.

  16. Expand OAuth Policies.

  17. Check Enable Client Credentials Flow and specify the username of the preferred Cloudaware user to run the app.

    note

    This user is considered the running user of the app. The API respects the permissions of the specified user while processing requests.

  18. Click Save.

  19. Allow some time for the app to update, or manually refresh the page.

  20. Go to the Settings tab.

  21. Expand OAuth Settings.

  22. Click Consumer Key and Secret.

  23. On the identity verification page, enter the code sent to the app contact email.

  24. View and copy the Client ID (Consumer Key) and Client Secret (Consumer Secret).