1. Registry
  2. Packages
  3. CloudAMQP Provider
  4. API Docs
  5. Oauth2Configuration
Viewing docs for CloudAMQP v3.36.0
published on Wednesday, Oct 14, 2026 by Pulumi
cloudamqp logo cloudamqp logo
Viewing docs for CloudAMQP v3.36.0
published on Wednesday, Oct 14, 2026 by Pulumi

    This resource allows you to configure OAuth2 authentication for your RabbitMQ or LavinMQ instance.

    Only available for dedicated subscription plans running RabbitMQ or LavinMQ. LavinMQ requires version 2.7.0 or newer.

    The resource looks up which broker the instance runs when creating or updating the configuration. Some attributes are only supported by one of the brokers, see Broker support. Setting an attribute the broker doesn’t support fails the apply with an error.

    Example Usage

    Basic OAuth2 configuration
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const oauth2Config = new cloudamqp.Oauth2Configuration("oauth2_config", {
        instanceId: Number(instance.id),
        resourceServerId: "test-resource-server",
        issuer: "https://test-issuer.example.com",
        verifyAud: true,
        oauthClientId: "test-client-id",
        oauthScopes: [
            "read",
            "write",
        ],
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    oauth2_config = cloudamqp.Oauth2Configuration("oauth2_config",
        instance_id=int(instance["id"]),
        resource_server_id="test-resource-server",
        issuer="https://test-issuer.example.com",
        verify_aud=True,
        oauth_client_id="test-client-id",
        oauth_scopes=[
            "read",
            "write",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2_config", &cloudamqp.Oauth2ConfigurationArgs{
    			InstanceId:       pulumi.Any(instance.Id),
    			ResourceServerId: pulumi.String("test-resource-server"),
    			Issuer:           pulumi.String("https://test-issuer.example.com"),
    			VerifyAud:        pulumi.Bool(true),
    			OauthClientId:    pulumi.String("test-client-id"),
    			OauthScopes: pulumi.StringArray{
    				pulumi.String("read"),
    				pulumi.String("write"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var oauth2Config = new CloudAmqp.Oauth2Configuration("oauth2_config", new()
        {
            InstanceId = instance.Id,
            ResourceServerId = "test-resource-server",
            Issuer = "https://test-issuer.example.com",
            VerifyAud = true,
            OauthClientId = "test-client-id",
            OauthScopes = new[]
            {
                "read",
                "write",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Oauth2Configuration;
    import com.pulumi.cloudamqp.Oauth2ConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var oauth2Config = new Oauth2Configuration("oauth2Config", Oauth2ConfigurationArgs.builder()
                .instanceId(instance.id())
                .resourceServerId("test-resource-server")
                .issuer("https://test-issuer.example.com")
                .verifyAud(true)
                .oauthClientId("test-client-id")
                .oauthScopes(            
                    "read",
                    "write")
                .build());
    
        }
    }
    
    resources:
      oauth2Config:
        type: cloudamqp:Oauth2Configuration
        name: oauth2_config
        properties:
          instanceId: ${instance.id}
          resourceServerId: test-resource-server
          issuer: https://test-issuer.example.com
          verifyAud: true
          oauthClientId: test-client-id
          oauthScopes:
            - read
            - write
    
    pulumi {
      required_providers {
        cloudamqp = {
          source = "pulumi/cloudamqp"
        }
      }
    }
    
    resource "cloudamqp_oauth2configuration" "oauth2_config" {
      instance_id        = instance.id
      resource_server_id = "test-resource-server"
      issuer             = "https://test-issuer.example.com"
      verify_aud         = true
      oauth_client_id    = "test-client-id"
      oauth_scopes       = ["read", "write"]
    }
    
    OAuth2 configuration with all optional fields
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const oauth2Config = new cloudamqp.Oauth2Configuration("oauth2_config", {
        instanceId: Number(instance.id),
        resourceServerId: "test-resource-server",
        issuer: "https://test-issuer.example.com",
        preferredUsernameClaims: [
            "preferred_username",
            "username",
        ],
        additionalScopesKeys: ["admin"],
        scopePrefix: "cloudamqp",
        scopeAliases: {
            read: "read:all",
            write: "write:all",
        },
        verifyAud: true,
        oauthClientId: "test-client-id",
        oauthScopes: [
            "read",
            "write",
            "admin",
        ],
        audience: "https://test-audience.example.com",
        disableBasicAuth: true,
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    oauth2_config = cloudamqp.Oauth2Configuration("oauth2_config",
        instance_id=int(instance["id"]),
        resource_server_id="test-resource-server",
        issuer="https://test-issuer.example.com",
        preferred_username_claims=[
            "preferred_username",
            "username",
        ],
        additional_scopes_keys=["admin"],
        scope_prefix="cloudamqp",
        scope_aliases={
            "read": "read:all",
            "write": "write:all",
        },
        verify_aud=True,
        oauth_client_id="test-client-id",
        oauth_scopes=[
            "read",
            "write",
            "admin",
        ],
        audience="https://test-audience.example.com",
        disable_basic_auth=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2_config", &cloudamqp.Oauth2ConfigurationArgs{
    			InstanceId:       pulumi.Any(instance.Id),
    			ResourceServerId: pulumi.String("test-resource-server"),
    			Issuer:           pulumi.String("https://test-issuer.example.com"),
    			PreferredUsernameClaims: pulumi.StringArray{
    				pulumi.String("preferred_username"),
    				pulumi.String("username"),
    			},
    			AdditionalScopesKeys: pulumi.StringArray{
    				pulumi.String("admin"),
    			},
    			ScopePrefix: pulumi.String("cloudamqp"),
    			ScopeAliases: pulumi.StringMap{
    				"read":  pulumi.String("read:all"),
    				"write": pulumi.String("write:all"),
    			},
    			VerifyAud:     pulumi.Bool(true),
    			OauthClientId: pulumi.String("test-client-id"),
    			OauthScopes: pulumi.StringArray{
    				pulumi.String("read"),
    				pulumi.String("write"),
    				pulumi.String("admin"),
    			},
    			Audience:         pulumi.String("https://test-audience.example.com"),
    			DisableBasicAuth: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var oauth2Config = new CloudAmqp.Oauth2Configuration("oauth2_config", new()
        {
            InstanceId = instance.Id,
            ResourceServerId = "test-resource-server",
            Issuer = "https://test-issuer.example.com",
            PreferredUsernameClaims = new[]
            {
                "preferred_username",
                "username",
            },
            AdditionalScopesKeys = new[]
            {
                "admin",
            },
            ScopePrefix = "cloudamqp",
            ScopeAliases = 
            {
                { "read", "read:all" },
                { "write", "write:all" },
            },
            VerifyAud = true,
            OauthClientId = "test-client-id",
            OauthScopes = new[]
            {
                "read",
                "write",
                "admin",
            },
            Audience = "https://test-audience.example.com",
            DisableBasicAuth = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Oauth2Configuration;
    import com.pulumi.cloudamqp.Oauth2ConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var oauth2Config = new Oauth2Configuration("oauth2Config", Oauth2ConfigurationArgs.builder()
                .instanceId(instance.id())
                .resourceServerId("test-resource-server")
                .issuer("https://test-issuer.example.com")
                .preferredUsernameClaims(            
                    "preferred_username",
                    "username")
                .additionalScopesKeys("admin")
                .scopePrefix("cloudamqp")
                .scopeAliases(Map.ofEntries(
                    Map.entry("read", "read:all"),
                    Map.entry("write", "write:all")
                ))
                .verifyAud(true)
                .oauthClientId("test-client-id")
                .oauthScopes(            
                    "read",
                    "write",
                    "admin")
                .audience("https://test-audience.example.com")
                .disableBasicAuth(true)
                .build());
    
        }
    }
    
    resources:
      oauth2Config:
        type: cloudamqp:Oauth2Configuration
        name: oauth2_config
        properties:
          instanceId: ${instance.id}
          resourceServerId: test-resource-server
          issuer: https://test-issuer.example.com
          preferredUsernameClaims:
            - preferred_username
            - username
          additionalScopesKeys:
            - admin
          scopePrefix: cloudamqp
          scopeAliases:
            read: read:all
            write: write:all
          verifyAud: true
          oauthClientId: test-client-id
          oauthScopes:
            - read
            - write
            - admin
          audience: https://test-audience.example.com
          disableBasicAuth: true
    
    pulumi {
      required_providers {
        cloudamqp = {
          source = "pulumi/cloudamqp"
        }
      }
    }
    
    resource "cloudamqp_oauth2configuration" "oauth2_config" {
      instance_id               = instance.id
      resource_server_id        = "test-resource-server"
      issuer                    = "https://test-issuer.example.com"
      preferred_username_claims = ["preferred_username", "username"]
      additional_scopes_keys    = ["admin"]
      scope_prefix              = "cloudamqp"
      scope_aliases = {
        "read"  = "read:all"
        "write" = "write:all"
      }
      verify_aud         = true
      oauth_client_id    = "test-client-id"
      oauth_scopes       = ["read", "write", "admin"]
      audience           = "https://test-audience.example.com"
      disable_basic_auth = true
    }
    
    Minimal OAuth2 configuration
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const oauth2Config = new cloudamqp.Oauth2Configuration("oauth2_config", {
        instanceId: Number(instance.id),
        resourceServerId: "test-resource-server",
        issuer: "https://test-issuer.example.com",
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    oauth2_config = cloudamqp.Oauth2Configuration("oauth2_config",
        instance_id=int(instance["id"]),
        resource_server_id="test-resource-server",
        issuer="https://test-issuer.example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2_config", &cloudamqp.Oauth2ConfigurationArgs{
    			InstanceId:       pulumi.Any(instance.Id),
    			ResourceServerId: pulumi.String("test-resource-server"),
    			Issuer:           pulumi.String("https://test-issuer.example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var oauth2Config = new CloudAmqp.Oauth2Configuration("oauth2_config", new()
        {
            InstanceId = instance.Id,
            ResourceServerId = "test-resource-server",
            Issuer = "https://test-issuer.example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Oauth2Configuration;
    import com.pulumi.cloudamqp.Oauth2ConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var oauth2Config = new Oauth2Configuration("oauth2Config", Oauth2ConfigurationArgs.builder()
                .instanceId(instance.id())
                .resourceServerId("test-resource-server")
                .issuer("https://test-issuer.example.com")
                .build());
    
        }
    }
    
    resources:
      oauth2Config:
        type: cloudamqp:Oauth2Configuration
        name: oauth2_config
        properties:
          instanceId: ${instance.id}
          resourceServerId: test-resource-server
          issuer: https://test-issuer.example.com
    
    pulumi {
      required_providers {
        cloudamqp = {
          source = "pulumi/cloudamqp"
        }
      }
    }
    
    resource "cloudamqp_oauth2configuration" "oauth2_config" {
      instance_id        = instance.id
      resource_server_id = "test-resource-server"
      issuer             = "https://test-issuer.example.com"
    }
    
    LavinMQ OAuth2 configuration
    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const oauth2Config = new cloudamqp.Oauth2Configuration("oauth2_config", {
        instanceId: Number(instance.id),
        issuer: "https://auth.example.com/realms/lavinmq",
        resourceServerId: "lavinmq",
        verifyAud: true,
        preferredUsernameClaims: ["preferred_username"],
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    oauth2_config = cloudamqp.Oauth2Configuration("oauth2_config",
        instance_id=int(instance["id"]),
        issuer="https://auth.example.com/realms/lavinmq",
        resource_server_id="lavinmq",
        verify_aud=True,
        preferred_username_claims=["preferred_username"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2_config", &cloudamqp.Oauth2ConfigurationArgs{
    			InstanceId:       pulumi.Any(instance.Id),
    			Issuer:           pulumi.String("https://auth.example.com/realms/lavinmq"),
    			ResourceServerId: pulumi.String("lavinmq"),
    			VerifyAud:        pulumi.Bool(true),
    			PreferredUsernameClaims: pulumi.StringArray{
    				pulumi.String("preferred_username"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var oauth2Config = new CloudAmqp.Oauth2Configuration("oauth2_config", new()
        {
            InstanceId = instance.Id,
            Issuer = "https://auth.example.com/realms/lavinmq",
            ResourceServerId = "lavinmq",
            VerifyAud = true,
            PreferredUsernameClaims = new[]
            {
                "preferred_username",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Oauth2Configuration;
    import com.pulumi.cloudamqp.Oauth2ConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var oauth2Config = new Oauth2Configuration("oauth2Config", Oauth2ConfigurationArgs.builder()
                .instanceId(instance.id())
                .issuer("https://auth.example.com/realms/lavinmq")
                .resourceServerId("lavinmq")
                .verifyAud(true)
                .preferredUsernameClaims("preferred_username")
                .build());
    
        }
    }
    
    resources:
      oauth2Config:
        type: cloudamqp:Oauth2Configuration
        name: oauth2_config
        properties:
          instanceId: ${instance.id}
          issuer: https://auth.example.com/realms/lavinmq
          resourceServerId: lavinmq
          verifyAud: true
          preferredUsernameClaims:
            - preferred_username
    
    pulumi {
      required_providers {
        cloudamqp = {
          source = "pulumi/cloudamqp"
        }
      }
    }
    
    resource "cloudamqp_oauth2configuration" "oauth2_config" {
      instance_id               = instance.id
      issuer                    = "https://auth.example.com/realms/lavinmq"
      resource_server_id        = "lavinmq"
      verify_aud                = true
      preferred_username_claims = ["preferred_username"]
    }
    
    LavinMQ OAuth2 configuration with management UI SSO login

    Requires LavinMQ 2.9.0 or newer, and 2.9.1 or newer for mgmtScopes.

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudamqp from "@pulumi/cloudamqp";
    
    const oauth2Config = new cloudamqp.Oauth2Configuration("oauth2_config", {
        instanceId: Number(instance.id),
        issuer: "https://auth.example.com/realms/lavinmq",
        resourceServerId: "lavinmq",
        additionalScopesKeys: ["roles"],
        oauthClientId: "lavinmq-mgmt",
        mgmtScopes: "openid profile email",
        jwksCacheTtl: 3600,
    });
    
    import pulumi
    import pulumi_cloudamqp as cloudamqp
    
    oauth2_config = cloudamqp.Oauth2Configuration("oauth2_config",
        instance_id=int(instance["id"]),
        issuer="https://auth.example.com/realms/lavinmq",
        resource_server_id="lavinmq",
        additional_scopes_keys=["roles"],
        oauth_client_id="lavinmq-mgmt",
        mgmt_scopes="openid profile email",
        jwks_cache_ttl=3600)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2_config", &cloudamqp.Oauth2ConfigurationArgs{
    			InstanceId:       pulumi.Any(instance.Id),
    			Issuer:           pulumi.String("https://auth.example.com/realms/lavinmq"),
    			ResourceServerId: pulumi.String("lavinmq"),
    			AdditionalScopesKeys: pulumi.StringArray{
    				pulumi.String("roles"),
    			},
    			OauthClientId: pulumi.String("lavinmq-mgmt"),
    			MgmtScopes:    pulumi.String("openid profile email"),
    			JwksCacheTtl:  pulumi.Int(3600),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudAmqp = Pulumi.CloudAmqp;
    
    return await Deployment.RunAsync(() => 
    {
        var oauth2Config = new CloudAmqp.Oauth2Configuration("oauth2_config", new()
        {
            InstanceId = instance.Id,
            Issuer = "https://auth.example.com/realms/lavinmq",
            ResourceServerId = "lavinmq",
            AdditionalScopesKeys = new[]
            {
                "roles",
            },
            OauthClientId = "lavinmq-mgmt",
            MgmtScopes = "openid profile email",
            JwksCacheTtl = 3600,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudamqp.Oauth2Configuration;
    import com.pulumi.cloudamqp.Oauth2ConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var oauth2Config = new Oauth2Configuration("oauth2Config", Oauth2ConfigurationArgs.builder()
                .instanceId(instance.id())
                .issuer("https://auth.example.com/realms/lavinmq")
                .resourceServerId("lavinmq")
                .additionalScopesKeys("roles")
                .oauthClientId("lavinmq-mgmt")
                .mgmtScopes("openid profile email")
                .jwksCacheTtl(3600)
                .build());
    
        }
    }
    
    resources:
      oauth2Config:
        type: cloudamqp:Oauth2Configuration
        name: oauth2_config
        properties:
          instanceId: ${instance.id}
          issuer: https://auth.example.com/realms/lavinmq
          resourceServerId: lavinmq
          additionalScopesKeys:
            - roles
          oauthClientId: lavinmq-mgmt
          mgmtScopes: openid profile email
          jwksCacheTtl: 3600
    
    pulumi {
      required_providers {
        cloudamqp = {
          source = "pulumi/cloudamqp"
        }
      }
    }
    
    resource "cloudamqp_oauth2configuration" "oauth2_config" {
      instance_id            = instance.id
      issuer                 = "https://auth.example.com/realms/lavinmq"
      resource_server_id     = "lavinmq"
      additional_scopes_keys = ["roles"]
      oauth_client_id        = "lavinmq-mgmt"
      mgmt_scopes            = "openid profile email"
      jwks_cache_ttl         = 3600
    }
    

    Broker support

    AttributeRabbitMQLavinMQ
    resourceServerIdYesYes
    issuerYesYes
    preferredUsernameClaimsYesYes
    additionalScopesKeyYesYes
    scopePrefixYesYes
    verifyAudYesYes
    audienceYesYes
    oauthClientIdYesYes, LavinMQ 2.9.0 or newer
    scopeAliasesYesNo
    oauthScopesYesNo
    disableBasicAuthYesNo
    jwksCacheTtlNoYes
    mgmtScopesNoYes, LavinMQ 2.9.1 or newer

    The CloudAMQP API requires LavinMQ 2.7.0 or newer for OAuth2 configuration.

    Dependency

    This resource depends on CloudAMQP instance identifier, cloudamqp_instance.instance.id.

    Notes

    • Changes to instanceId will force recreation of the resource.
    • OAuth2 configuration changes are applied asynchronously and may take some time to complete. The resource will poll for job completion using the configured sleep and timeout values.
    • Only one OAuth2 configuration can exist per instance. Creating a new configuration will replace any existing configuration.
    • After a configuration has been applied, a restart of RabbitMQ is required for the changes to take effect.
    • For LavinMQ with oauthClientId set, the management UI base URL used for the SSO login callback defaults to the instance hostname. Overriding it (mgmtBaseUrl in the API) is not supported by this resource.

    Create Oauth2Configuration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Oauth2Configuration(name: string, args: Oauth2ConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def Oauth2Configuration(resource_name: str,
                            args: Oauth2ConfigurationArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Oauth2Configuration(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            instance_id: Optional[int] = None,
                            resource_server_id: Optional[str] = None,
                            issuer: Optional[str] = None,
                            oauth_scopes: Optional[Sequence[str]] = None,
                            disable_basic_auth: Optional[bool] = None,
                            jwks_cache_ttl: Optional[int] = None,
                            mgmt_scopes: Optional[str] = None,
                            oauth_client_id: Optional[str] = None,
                            additional_scopes_keys: Optional[Sequence[str]] = None,
                            preferred_username_claims: Optional[Sequence[str]] = None,
                            audience: Optional[str] = None,
                            scope_aliases: Optional[Mapping[str, str]] = None,
                            scope_prefix: Optional[str] = None,
                            sleep: Optional[int] = None,
                            timeout: Optional[int] = None,
                            verify_aud: Optional[bool] = None)
    func NewOauth2Configuration(ctx *Context, name string, args Oauth2ConfigurationArgs, opts ...ResourceOption) (*Oauth2Configuration, error)
    public Oauth2Configuration(string name, Oauth2ConfigurationArgs args, CustomResourceOptions? opts = null)
    public Oauth2Configuration(String name, Oauth2ConfigurationArgs args)
    public Oauth2Configuration(String name, Oauth2ConfigurationArgs args, CustomResourceOptions options)
    
    type: cloudamqp:Oauth2Configuration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "cloudamqp_oauth2_configuration" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args Oauth2ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args Oauth2ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args Oauth2ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Oauth2ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Oauth2ConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var oauth2ConfigurationResource = new CloudAmqp.Oauth2Configuration("oauth2ConfigurationResource", new()
    {
        InstanceId = 0,
        ResourceServerId = "string",
        Issuer = "string",
        OauthScopes = new[]
        {
            "string",
        },
        DisableBasicAuth = false,
        JwksCacheTtl = 0,
        MgmtScopes = "string",
        OauthClientId = "string",
        AdditionalScopesKeys = new[]
        {
            "string",
        },
        PreferredUsernameClaims = new[]
        {
            "string",
        },
        Audience = "string",
        ScopeAliases = 
        {
            { "string", "string" },
        },
        ScopePrefix = "string",
        Sleep = 0,
        Timeout = 0,
        VerifyAud = false,
    });
    
    example, err := cloudamqp.NewOauth2Configuration(ctx, "oauth2ConfigurationResource", &cloudamqp.Oauth2ConfigurationArgs{
    	InstanceId:       pulumi.Int(0),
    	ResourceServerId: pulumi.String("string"),
    	Issuer:           pulumi.String("string"),
    	OauthScopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DisableBasicAuth: pulumi.Bool(false),
    	JwksCacheTtl:     pulumi.Int(0),
    	MgmtScopes:       pulumi.String("string"),
    	OauthClientId:    pulumi.String("string"),
    	AdditionalScopesKeys: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PreferredUsernameClaims: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Audience: pulumi.String("string"),
    	ScopeAliases: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ScopePrefix: pulumi.String("string"),
    	Sleep:       pulumi.Int(0),
    	Timeout:     pulumi.Int(0),
    	VerifyAud:   pulumi.Bool(false),
    })
    
    resource "cloudamqp_oauth2_configuration" "oauth2ConfigurationResource" {
      lifecycle {
        create_before_destroy = true
      }
      instance_id               = 0
      resource_server_id        = "string"
      issuer                    = "string"
      oauth_scopes              = ["string"]
      disable_basic_auth        = false
      jwks_cache_ttl            = 0
      mgmt_scopes               = "string"
      oauth_client_id           = "string"
      additional_scopes_keys    = ["string"]
      preferred_username_claims = ["string"]
      audience                  = "string"
      scope_aliases = {
        "string" = "string"
      }
      scope_prefix = "string"
      sleep        = 0
      timeout      = 0
      verify_aud   = false
    }
    
    var oauth2ConfigurationResource = new Oauth2Configuration("oauth2ConfigurationResource", Oauth2ConfigurationArgs.builder()
        .instanceId(0)
        .resourceServerId("string")
        .issuer("string")
        .oauthScopes("string")
        .disableBasicAuth(false)
        .jwksCacheTtl(0)
        .mgmtScopes("string")
        .oauthClientId("string")
        .additionalScopesKeys("string")
        .preferredUsernameClaims("string")
        .audience("string")
        .scopeAliases(Map.of("string", "string"))
        .scopePrefix("string")
        .sleep(0)
        .timeout(0)
        .verifyAud(false)
        .build());
    
    oauth2_configuration_resource = cloudamqp.Oauth2Configuration("oauth2ConfigurationResource",
        instance_id=0,
        resource_server_id="string",
        issuer="string",
        oauth_scopes=["string"],
        disable_basic_auth=False,
        jwks_cache_ttl=0,
        mgmt_scopes="string",
        oauth_client_id="string",
        additional_scopes_keys=["string"],
        preferred_username_claims=["string"],
        audience="string",
        scope_aliases={
            "string": "string",
        },
        scope_prefix="string",
        sleep=0,
        timeout=0,
        verify_aud=False)
    
    const oauth2ConfigurationResource = new cloudamqp.Oauth2Configuration("oauth2ConfigurationResource", {
        instanceId: 0,
        resourceServerId: "string",
        issuer: "string",
        oauthScopes: ["string"],
        disableBasicAuth: false,
        jwksCacheTtl: 0,
        mgmtScopes: "string",
        oauthClientId: "string",
        additionalScopesKeys: ["string"],
        preferredUsernameClaims: ["string"],
        audience: "string",
        scopeAliases: {
            string: "string",
        },
        scopePrefix: "string",
        sleep: 0,
        timeout: 0,
        verifyAud: false,
    });
    
    type: cloudamqp:Oauth2Configuration
    properties:
        additionalScopesKeys:
            - string
        audience: string
        disableBasicAuth: false
        instanceId: 0
        issuer: string
        jwksCacheTtl: 0
        mgmtScopes: string
        oauthClientId: string
        oauthScopes:
            - string
        preferredUsernameClaims:
            - string
        resourceServerId: string
        scopeAliases:
            string: string
        scopePrefix: string
        sleep: 0
        timeout: 0
        verifyAud: false
    

    Oauth2Configuration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Oauth2Configuration resource accepts the following input properties:

    InstanceId int
    The CloudAMQP instance ID.
    Issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    ResourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    AdditionalScopesKeys List<string>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    Audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    DisableBasicAuth bool
    Disable static username/password management interface access. RabbitMQ only.
    JwksCacheTtl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    MgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    OauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    OauthScopes List<string>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    PreferredUsernameClaims List<string>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    ScopeAliases Dictionary<string, string>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    ScopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    Sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    Timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    VerifyAud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    InstanceId int
    The CloudAMQP instance ID.
    Issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    ResourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    AdditionalScopesKeys []string
    List of additional JWT claim keys to extract OAuth2 scopes from.
    Audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    DisableBasicAuth bool
    Disable static username/password management interface access. RabbitMQ only.
    JwksCacheTtl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    MgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    OauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    OauthScopes []string
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    PreferredUsernameClaims []string
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    ScopeAliases map[string]string
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    ScopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    Sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    Timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    VerifyAud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    instance_id number
    The CloudAMQP instance ID.
    issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    resource_server_id string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    additional_scopes_keys list(string)
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disable_basic_auth bool
    Disable static username/password management interface access. RabbitMQ only.
    jwks_cache_ttl number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmt_scopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauth_client_id string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauth_scopes list(string)
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferred_username_claims list(string)
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    scope_aliases map(string)
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scope_prefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verify_aud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    instanceId Integer
    The CloudAMQP instance ID.
    issuer String
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    resourceServerId String
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    additionalScopesKeys List<String>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience String
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth Boolean
    Disable static username/password management interface access. RabbitMQ only.
    jwksCacheTtl Integer
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes String
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId String
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes List<String>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims List<String>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    scopeAliases Map<String,String>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix String
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep Integer
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout Integer
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud Boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    instanceId number
    The CloudAMQP instance ID.
    issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    resourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    additionalScopesKeys string[]
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth boolean
    Disable static username/password management interface access. RabbitMQ only.
    jwksCacheTtl number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes string[]
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims string[]
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    scopeAliases {[key: string]: string}
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    instance_id int
    The CloudAMQP instance ID.
    issuer str
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    resource_server_id str
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    additional_scopes_keys Sequence[str]
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience str
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disable_basic_auth bool
    Disable static username/password management interface access. RabbitMQ only.
    jwks_cache_ttl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmt_scopes str
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauth_client_id str
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauth_scopes Sequence[str]
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferred_username_claims Sequence[str]
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    scope_aliases Mapping[str, str]
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scope_prefix str
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verify_aud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    instanceId Number
    The CloudAMQP instance ID.
    issuer String
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    resourceServerId String
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    additionalScopesKeys List<String>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience String
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth Boolean
    Disable static username/password management interface access. RabbitMQ only.
    jwksCacheTtl Number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes String
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId String
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes List<String>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims List<String>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    scopeAliases Map<String>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix String
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep Number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout Number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud Boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Oauth2Configuration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Oauth2Configuration Resource

    Get an existing Oauth2Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: Oauth2ConfigurationState, opts?: CustomResourceOptions): Oauth2Configuration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_scopes_keys: Optional[Sequence[str]] = None,
            audience: Optional[str] = None,
            disable_basic_auth: Optional[bool] = None,
            instance_id: Optional[int] = None,
            issuer: Optional[str] = None,
            jwks_cache_ttl: Optional[int] = None,
            mgmt_scopes: Optional[str] = None,
            oauth_client_id: Optional[str] = None,
            oauth_scopes: Optional[Sequence[str]] = None,
            preferred_username_claims: Optional[Sequence[str]] = None,
            resource_server_id: Optional[str] = None,
            scope_aliases: Optional[Mapping[str, str]] = None,
            scope_prefix: Optional[str] = None,
            sleep: Optional[int] = None,
            timeout: Optional[int] = None,
            verify_aud: Optional[bool] = None) -> Oauth2Configuration
    func GetOauth2Configuration(ctx *Context, name string, id IDInput, state *Oauth2ConfigurationState, opts ...ResourceOption) (*Oauth2Configuration, error)
    public static Oauth2Configuration Get(string name, Input<string> id, Oauth2ConfigurationState? state, CustomResourceOptions? opts = null)
    public static Oauth2Configuration get(String name, Output<String> id, Oauth2ConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: cloudamqp:Oauth2Configuration    get:      id: ${id}
    import {
      to = cloudamqp_oauth2_configuration.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalScopesKeys List<string>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    Audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    DisableBasicAuth bool
    Disable static username/password management interface access. RabbitMQ only.
    InstanceId int
    The CloudAMQP instance ID.
    Issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    JwksCacheTtl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    MgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    OauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    OauthScopes List<string>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    PreferredUsernameClaims List<string>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    ResourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    ScopeAliases Dictionary<string, string>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    ScopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    Sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    Timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    VerifyAud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    AdditionalScopesKeys []string
    List of additional JWT claim keys to extract OAuth2 scopes from.
    Audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    DisableBasicAuth bool
    Disable static username/password management interface access. RabbitMQ only.
    InstanceId int
    The CloudAMQP instance ID.
    Issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    JwksCacheTtl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    MgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    OauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    OauthScopes []string
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    PreferredUsernameClaims []string
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    ResourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    ScopeAliases map[string]string
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    ScopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    Sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    Timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    VerifyAud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    additional_scopes_keys list(string)
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disable_basic_auth bool
    Disable static username/password management interface access. RabbitMQ only.
    instance_id number
    The CloudAMQP instance ID.
    issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    jwks_cache_ttl number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmt_scopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauth_client_id string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauth_scopes list(string)
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferred_username_claims list(string)
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    resource_server_id string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    scope_aliases map(string)
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scope_prefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verify_aud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    additionalScopesKeys List<String>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience String
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth Boolean
    Disable static username/password management interface access. RabbitMQ only.
    instanceId Integer
    The CloudAMQP instance ID.
    issuer String
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    jwksCacheTtl Integer
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes String
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId String
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes List<String>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims List<String>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    resourceServerId String
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    scopeAliases Map<String,String>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix String
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep Integer
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout Integer
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud Boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    additionalScopesKeys string[]
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience string
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth boolean
    Disable static username/password management interface access. RabbitMQ only.
    instanceId number
    The CloudAMQP instance ID.
    issuer string
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    jwksCacheTtl number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes string
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId string
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes string[]
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims string[]
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    resourceServerId string
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    scopeAliases {[key: string]: string}
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix string
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    additional_scopes_keys Sequence[str]
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience str
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disable_basic_auth bool
    Disable static username/password management interface access. RabbitMQ only.
    instance_id int
    The CloudAMQP instance ID.
    issuer str
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    jwks_cache_ttl int
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmt_scopes str
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauth_client_id str
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauth_scopes Sequence[str]
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferred_username_claims Sequence[str]
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    resource_server_id str
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    scope_aliases Mapping[str, str]
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scope_prefix str
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep int
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout int
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verify_aud bool
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.
    additionalScopesKeys List<String>
    List of additional JWT claim keys to extract OAuth2 scopes from.
    audience String
    The audience to be passed along to the Oauth2 provider when logging in to the management interface. Must be configured for Auth0, cannot be configured for Entra ID v2.
    disableBasicAuth Boolean
    Disable static username/password management interface access. RabbitMQ only.
    instanceId Number
    The CloudAMQP instance ID.
    issuer String
    The issuer URL of the OAuth2 provider. This is typically the base URL of your OAuth2 provider (e.g., Auth0, Keycloak, etc.).
    jwksCacheTtl Number
    How long JWKS signing keys are cached before being re-fetched from the identity provider, in seconds. Between 0 and 86400. LavinMQ only.
    mgmtScopes String
    Space-separated OAuth2 scopes requested during management UI SSO login, used together with oauthClientId. Requires LavinMQ 2.9.1 or newer. LavinMQ only.
    oauthClientId String
    OAuth2 client ID used for token validation. For LavinMQ, this is the client ID for management UI SSO login, which requires LavinMQ 2.9.0 or newer.
    oauthScopes List<String>
    List of OAuth2 scopes to request. These scopes will be used when obtaining access tokens.
    preferredUsernameClaims List<String>
    List of JWT claims to use as the preferred username. The first claim found in the token will be used as the username.
    resourceServerId String
    Resource server identifier used to identify the resource server in OAuth2 tokens.
    scopeAliases Map<String>
    Map of scope aliases to translate scope names. This allows mapping OAuth2 scopes to RabbitMQ permission tags.
    scopePrefix String
    Prefix to add to scopes. This is useful when scopes in the JWT token need to be prefixed for RabbitMQ permissions.
    sleep Number
    Configurable sleep time in seconds between retries for OAuth2 configuration. Default set to 60 seconds.
    timeout Number
    Configurable timeout time in seconds for OAuth2 configuration. Default set to 3600 seconds.
    verifyAud Boolean
    Whether to verify the audience claim in the JWT token. When not set, RabbitMQ is configured with false and LavinMQ uses the API default, true.

    Package Details

    Repository
    CloudAMQP pulumi/pulumi-cloudamqp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudamqp Terraform Provider.
    cloudamqp logo cloudamqp logo
    Viewing docs for CloudAMQP v3.36.0
    published on Wednesday, Oct 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial