Skip to main content

External Client App with OAuth 2.0 JWT Bearer Flow

This guide explains how to configure an external client app using OAuth 2.0 JWT Bearer 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.`

The OAuth 2.0 JWT Bearer Flow requires an RSA X.509 certificate with a private key for signing tokens. You may use an existing certificate if it meets these criteria:

  • Uses RSA encryption (2048-bit or stronger).
  • Includes Digital Signature in Key Usage.
  • Is in PEM, CRT, or DER format.

Otherwise, generate a new certificate using OpenSSL. For more details, use Salesforce key and certificate instructions.

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)
    • Optional: Access Analytics REST API resources (wave_api) to access Cloudaware Analytics datasets programmatically.

  10. Under Flow Enablement, check Enable JWT Bearer Flow and upload the X.509 certificate that will be used to verify your JWT.

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

  12. Click Create.

  13. Ensure that the app has the Enabled status.

  14. In the Policies tab, click Edit.

  15. Expand OAuth Policies.

  16. Choose Admin approved users are pre-authorized.

  17. Move the required Cloudaware profiles to Selected Profiles.

  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).