Some of the content described in this article is available in meshIQ Manage versions 12.1 and later.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.  

Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier

Version 12.x and Later

The Browse OAuth Options feature allows administrators to view, add, and delete JWT claims configured for a specific REST Consumer directly from the console.

OAuth options in a Solace REST Consumer define the JWT (JSON Web Token) claims that are attached to outbound REST requests when OAuth authentication is enabled. These claims help REST endpoints validate and authorize incoming requests from Solace.

Browse Existing OAuth Options

1. In the Rest Consumer widget, select the REST Consumer you want to manage.

2. From the Selected menu, click Browse OAuth Options.
   

3. A new tab opens in the Console, displaying all configured JWT claims. To add a new OAuth Claim, refer to the instructions below.
   

Add a New OAuth Claim

To add an OAuth JWT claim:

1. In the OAuth Options tab, click the Add OAuth Jwt Claim button.

2. The Solace Rest Consumer OAuth JWT Claims dialog opens.
   

3. Enter the details:

   • Name — The JWT claim name.

   • Value — The corresponding value.

4. Click + to add multiple claims if needed.

5. Click Ok to apply the claim immediately or Schedule to apply it later.
   (See Scheduling Jobs for more information.)

Once added, the new JWT claim appears in the OAuth Options list.

Delete an OAuth Claim

To remove a specific OAuth claim:

1. Select the claim you want to delete. From the Selected menu, choose Delete.

2. The Confirm Delete Action dialog opens.
   

3. Click Yes to delete it immediately or Schedule to delete it later. (See Scheduling Jobs for more information.)

Delete All OAuth Claims

To remove all OAuth claims at once:

1. Click the Delete all objects button in the OAuth Options tab in the console.

2. The Confirm Delete Action dialog opens.
   

3. Click Yes to delete all claims immediately or Schedule to delete them later. (See Scheduling Jobs for more information.)

This feature is useful when resetting or reconfiguring authentication settings for a REST Consumer.

Version 11.3 and Earlier

The Browse OAuth Options feature allows administrators to view, add, and delete JWT claims configured for a specific REST Consumer directly from the console.

OAuth options in a Solace REST Consumer define the JWT (JSON Web Token) claims that are attached to outbound REST requests when OAuth authentication is enabled. These claims help REST endpoints validate and authorize incoming requests from Solace.

Browse Existing OAuth Options

1. In the Rest Consumer viewlet, select the REST Consumer you want to manage.

2. From the Selected menu, click Browse OAuth Options.
   

3. A new tab opens in the console, displaying all configured JWT claims. To add a new OAuth Claim, refer to the instructions below.
   

Add a New OAuth Claim

To add an OAuth JWT claim:

1. In the OAuth Options tab, click the Add OAuth Jwt Claim button.

2. The Solace Rest Consumer OAuth JWT Claims dialog opens.
   

3. Enter the details:

   • Name — The JWT claim name.

   • Value — The corresponding value.

4. Click + to add multiple claims if needed.

5. Click Ok to apply the claim immediately or Schedule to apply it later.
   (See Scheduling Jobs for more information.)

Once added, the new JWT claim appears in the OAuth Options list.

Delete an OAuth Claim

To remove a specific OAuth claim:

1. Select the claim you want to delete. From the Selected menu, choose Delete.

2. The Confirm Delete Action dialog opens.
   

3. Click Yes to delete it immediately or Schedule to delete it later. (See Scheduling Jobs for more information.)

Delete All OAuth Claims

To remove all OAuth claims at once:

1. Click the Delete all objects button in the OAuth Options tab in the console.

2. The Confirm Delete Action dialog opens.
   

3. Click Yes to delete all claims immediately or Schedule to delete them later. (See Scheduling Jobs for more information.)

This feature is useful when resetting or reconfiguring authentication settings for a REST Consumer.