v1

latestOpenAPI 3.1.22026-08-0611530152.3 KB

OAuth 2.0

Get OAuth 2.0 configuration

Retrieve the current OAuth 2.0 configuration for the instance

get/oauth2-configurations

Response

Successfully retrieved OAuth 2.0 configuration

resource_server_idstring

Unique identifier for the resource server

issuerstring uri

OAuth 2.0 issuer URL (must be HTTPS)

preferred_username_claimsstring[]

JWT claim names to use for username

additional_scopes_keystring[]

JWT claim keys containing additional scopes

scope_prefixstring

Prefix to add to scopes

scope_aliasesobject

Map scope aliases to actual scopes (RabbitMQ 4.1.0+)

verify_audboolean

Whether to verify audience claim in tokens

oauth_client_idstring

Client ID for management interface

oauth_scopesstring[]

Scopes required for management interface

audiencestring

OAuth 2.0 audience claim (required for Auth0 with RabbitMQ 4.1+). Typically matches resource_server_id

oauth_disable_basic_authboolean

Disable static username/password management interface access, allowing only OAuth 2.0 authentication

idstring uuid

Configuration ID

created_atstring date-time

Configuration creation timestamp

updated_atstring date-time

Configuration last update timestamp

Example response

{
  "resource_server_id": "rabbitmq",
  "issuer": "https://auth.example.com",
  "preferred_username_claims": [
    "sub",
    "email"
  ],
  "additional_scopes_key": [
    "roles",
    "groups"
  ],
  "scope_prefix": "my-app:",
  "scope_aliases": {
    "user": "user:read",
    "admin": "admin:access"
  },
  "verify_aud": true,
  "oauth_client_id": "oauth-client-id-456",
  "oauth_scopes": [
    "manage:clients",
    "read:users"
  ],
  "audience": "rabbitmq",
  "oauth_disable_basic_auth": true,
  "id": "669b23ed-7dc9-451d-82c6-b65f49cb1a9a",
  "created_at": "2025-09-23T12:40:34Z",
  "updated_at": "2025-09-23T12:40:34Z"
}