Cloudaware Documentation
Cloudaware Documentation
Breadcrumbs

Connected App with OAuth 2.0 Client Credentials Flow (legacy)

This guide explains how to configure a connected app using OAuth 2.0 Client Credentials Flow for Cloudaware CMDB API access. Connected Apps are a legacy feature. It is recommended to use External Client Apps.

Prerequisites

Contact your dedicated technical account manager or tam@cloudaware.com to enable the App Manager feature for your Cloudaware account. Once the feature is enabled, proceed with the setup.

Set up the app


  1. Log in to Cloudaware → Setup.

    CMDB - Connected App - setup.png


  2. Search for Apps in the Quick Find bar. Under External Client Apps, select the Settings tab → New Connected App.

    CMDB - Connected App - click New Connected App.png


  3. Set a name and a contact email for the connected app. The API name will be auto-populated.

  4. Under API (Enable OAuth Settings), check the box 'Enable OAuth Settings'. Use http://localhost:1717/OauthRedirect in the Callback URL field. 

    CMDB - Connected App - check the box Enable OAuth Settings & set URL.png


  5. Select the following OAuth scopes:

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

    CMDB - Connected App - select OAuth scopes.png


  6. Uncheck the 'Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows' box if it is not required.

  7. Check the box 'Enable Client Credentials Flow'. Click OK in the popup window. Scroll down and click Save.

  8. A message will appear informing that the changes may take some time to be applied. Click Continue to be redirected to the New Connected App page.

    CMDB - Connected App - the new app - click Continue.png


  9. Click Manage Consumer Details.

    CMDB - Connected App - the new app - click Manage Consumer Details.png


  10. Check your email to get the code required to verify your identity.


  11. Copy & save Consumer Key and Consumer Secret. These credentials should be used as client_id and client_secret in authorization API requests to obtain an access token.

    CMDB - Connected App - copy consumer key & secret.png


    Click the link 'Back to Manage Connected Apps'.

  12. Click Manage → Edit Policies:

    CMDB - Connected App - the new app - click Manage.png


    CMDB - Connected App - the new app - click Edit Policies.png


  13. Under 'Client Credentials Flow' in '(Run As)', click on the magnifying glass icon:

    CMDB - Connected App - the new app - Client Credential Flow.png


    In a popup window, select a preferred user* using the list of users or a search bar:

    CMDB - Connected App - the new app - select the running user.png

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


  1. Once the popup window is closed, get back to the Edit Policies page. Scroll down and click Save.