Contact Us 1-800-596-4880
  1. Homepage
  2. MQ
  3. Configuring Anypoint MQ

  4. Configuring Connected Apps

Configuring Connected Apps

The Connected Apps feature enables you to integrate external applications with Anypoint Platform by providing access to those applications without sharing your user credentials.

When you create a connected app, Access Management lists the ID and secret for the app. You use the ID and secret values when configuring Anypoint Connector for MQ (Anypoint MQ Connector) in a Mule app in Anypoint Studio.

To use connected apps with Anypoint MQ, you must use Anypoint MQ Connector 4.x for Mule 4. For information about upgrading, see Upgrading and Migrating Anypoint MQ Connector. If you are using Anypoint MQ Connector version 3.x or earlier, configure a client app instead. For information, see Configuring Client Apps.

For more information about connected apps, see Connected Apps and Connected Apps for Developers.

Configure a Connected App in Access Management

To create a connected app with Anypoint MQ scopes:

  1. In Anypoint Platform, go to Access Management.

  2. Click Connected Apps in the navigation pane.

  3. Click Create app.

    Connected Apps navigation option and Create app button in Access Management
    1 Connected Apps menu option displays and creates connected apps.
    2 Create app button creates a connected app.

  4. Specify a name, such as DemoApp1 for the app.

  5. Select App acts on its own behalf (client credentials).

  6. Click Add Scopes.

    Scopes are roles with associated permissions, which determine which actions the app can perform within an organization and environment. See Anypoint MQ Scopes.

    Add Scopes window showing the scopes to add to Anypoint MQ connected apps

  7. In Add Scopes window:

    1. Enter "MQ" in the Filter scopes field.

    2. Select the Anypoint MQ scopes to apply and click Next.

    3. Select business groups to apply the scopes to and click Next.

    4. Select the environments to apply the scopes to and click Next.

    5. Click Add Scopes or Cancel to cancel your changes.

  8. Click Save or Cancel to cancel your changes.

  9. When you configure the connector, click Copy Id and Copy Secret to copy the ID and secret for the app you just created:

    Connected Apps window

    Use this ID and secret to get the access token required to authenticate with the Anypoint MQ API.

  10. When you configure Anypoint MQ Connector in your Mule app, paste the ID and secret values in the Anypoint MQ Config window in Studio:

    Anypoint MQ Config window showing the URL, Client App ID, and Client Secret fields

    Don’t share the ID and secret pair with multiple apps.

    For more information, see Create and Connect a Mule 4 App to Anypoint MQ in Anypoint Studio 7 in the Anypoint MQ tutorial.

For information about getting the access token for connected apps, see the Connected App Examples in the Access Management API.

The /authorize endpoints in the Anypoint MQ Admin API and Anypoint MQ Broker API do not support connected apps. You can’t use tokens obtained from those endpoints to access a connected app.

Configure a Connected App Using the API

For information about configuring a connected app with the API, see How to create connected apps using the API.

Anypoint MQ Scopes

Anypoint MQ scopes apply to all destinations in the given organization and environment.

The Anypoint MQ scopes are:

Scope in UI Scope in API Description

Administer destinations

administer:destinations

  • View all destinations and each destination’s settings (ID, Type, Message TTL, and Message Lock Default TTL).

  • View In Queue messages.

  • View In Flight message stats.

    • Create new queues, message exchanges, and bindings.

    • Edit existing queues, message exchanges, and bindings.

    • Purge messages from queues.

Clear destinations

clear:destinations

  • View all destinations and each destination’s settings (ID, Type, Message TTL, and Message Lock Default TTL).

  • View In Queue messages.

  • View In Flight message stats.

Destination subscriber for given environment

subscribe:destinations

  • Consume messages from a destination.

  • Delete messages from a destination.

Destination publisher for given environment

publish:destinations

  • Send messages to a destination.

  • Update message TTL on a destination.

Manage clients

manage:clients

  • View all client apps, including client app IDs and client secrets for each client app.

  • Create client apps.

Read MQ stats

read:stats

View organization and environment statistics.

View clients

view:clients

View all client apps, including client app IDs and client secrets for each client app.

View destinations

view:destinations

  • View all destinations and each destination’s settings (ID, Type, Message TTL, and Message Lock Default TTL).

  • View In Queue messages.

  • View In Flight message stats.