RealmDefaultClientScopesArgs

data class RealmDefaultClientScopesArgs(val defaultScopes: Output<List<String>>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<RealmDefaultClientScopesArgs>

Allows you to manage the set of default client scopes for a Keycloak realm, which are used when new clients are created. Note that this resource attempts to be an authoritative source over the default client scopes for a Keycloak realm, so any Keycloak defaults and manual adjustments will be overwritten.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = new keycloak.Realm("realm", {
realm: "my-realm",
enabled: true,
});
const clientScope = new keycloak.openid.ClientScope("client_scope", {
realmId: realm.id,
name: "test-client-scope",
});
const defaultScopes = new keycloak.RealmDefaultClientScopes("default_scopes", {
realmId: realm.id,
defaultScopes: [
"profile",
"email",
"roles",
"web-origins",
clientScope.name,
],
});
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
realm="my-realm",
enabled=True)
client_scope = keycloak.openid.ClientScope("client_scope",
realm_id=realm.id,
name="test-client-scope")
default_scopes = keycloak.RealmDefaultClientScopes("default_scopes",
realm_id=realm.id,
default_scopes=[
"profile",
"email",
"roles",
"web-origins",
client_scope.name,
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;
return await Deployment.RunAsync(() =>
{
var realm = new Keycloak.Realm("realm", new()
{
RealmName = "my-realm",
Enabled = true,
});
var clientScope = new Keycloak.OpenId.ClientScope("client_scope", new()
{
RealmId = realm.Id,
Name = "test-client-scope",
});
var defaultScopes = new Keycloak.RealmDefaultClientScopes("default_scopes", new()
{
RealmId = realm.Id,
DefaultScopes = new[]
{
"profile",
"email",
"roles",
"web-origins",
clientScope.Name,
},
});
});
package main
import (
"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak/openid"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
Realm: pulumi.String("my-realm"),
Enabled: pulumi.Bool(true),
})
if err != nil {
return err
}
clientScope, err := openid.NewClientScope(ctx, "client_scope", &openid.ClientScopeArgs{
RealmId: realm.ID(),
Name: pulumi.String("test-client-scope"),
})
if err != nil {
return err
}
_, err = keycloak.NewRealmDefaultClientScopes(ctx, "default_scopes", &keycloak.RealmDefaultClientScopesArgs{
RealmId: realm.ID(),
DefaultScopes: pulumi.StringArray{
pulumi.String("profile"),
pulumi.String("email"),
pulumi.String("roles"),
pulumi.String("web-origins"),
clientScope.Name,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.openid.ClientScope;
import com.pulumi.keycloak.openid.ClientScopeArgs;
import com.pulumi.keycloak.RealmDefaultClientScopes;
import com.pulumi.keycloak.RealmDefaultClientScopesArgs;
import java.util.List;
import java.util.ArrayList;
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 realm = new Realm("realm", RealmArgs.builder()
.realm("my-realm")
.enabled(true)
.build());
var clientScope = new ClientScope("clientScope", ClientScopeArgs.builder()
.realmId(realm.id())
.name("test-client-scope")
.build());
var defaultScopes = new RealmDefaultClientScopes("defaultScopes", RealmDefaultClientScopesArgs.builder()
.realmId(realm.id())
.defaultScopes(
"profile",
"email",
"roles",
"web-origins",
clientScope.name())
.build());
}
}
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
clientScope:
type: keycloak:openid:ClientScope
name: client_scope
properties:
realmId: ${realm.id}
name: test-client-scope
defaultScopes:
type: keycloak:RealmDefaultClientScopes
name: default_scopes
properties:
realmId: ${realm.id}
defaultScopes:
- profile
- email
- roles
- web-origins
- ${clientScope.name}

Import

This resource does not support import. Instead of importing, feel free to create this resource as if it did not already exist on the server.

Constructors

Link copied to clipboard
constructor(defaultScopes: Output<List<String>>? = null, realmId: Output<String>? = null)

Properties

Link copied to clipboard
val defaultScopes: Output<List<String>>? = null

An array of default client scope names that should be used when creating new Keycloak clients.

Link copied to clipboard
val realmId: Output<String>? = null

The realm this client and scopes exists in.

Functions

Link copied to clipboard
open override fun toJava(): RealmDefaultClientScopesArgs