DefaultGroupsArgs

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

Allows for managing a realm's default groups.

You should not use keycloak.DefaultGroups with a group whose members are managed by keycloak.GroupMemberships.

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 group = new keycloak.Group("group", {
realmId: realm.id,
name: "my-group",
});
const _default = new keycloak.DefaultGroups("default", {
realmId: realm.id,
groupIds: [group&#46;id],
});
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
realm="my-realm",
enabled=True)
group = keycloak.Group("group",
realm_id=realm.id,
name="my-group")
default = keycloak.DefaultGroups("default",
realm_id=realm.id,
group_ids=[group&#46;id])
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 @group = new Keycloak.Group("group", new()
{
RealmId = realm.Id,
Name = "my-group",
});
var @default = new Keycloak.DefaultGroups("default", new()
{
RealmId = realm.Id,
GroupIds = new[]
{
@group.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
"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
}
group, err := keycloak.NewGroup(ctx, "group", &keycloak.GroupArgs{
RealmId: realm.ID(),
Name: pulumi.String("my-group"),
})
if err != nil {
return err
}
_, err = keycloak.NewDefaultGroups(ctx, "default", &keycloak.DefaultGroupsArgs{
RealmId: realm.ID(),
GroupIds: pulumi.StringArray{
group.ID(),
},
})
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.Group;
import com.pulumi.keycloak.GroupArgs;
import com.pulumi.keycloak.DefaultGroups;
import com.pulumi.keycloak.DefaultGroupsArgs;
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 group = new Group("group", GroupArgs.builder()
.realmId(realm.id())
.name("my-group")
.build());
var default_ = new DefaultGroups("default", DefaultGroupsArgs.builder()
.realmId(realm.id())
.groupIds(group.id())
.build());
}
}
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
group:
type: keycloak:Group
properties:
realmId: ${realm.id}
name: my-group
default:
type: keycloak:DefaultGroups
properties:
realmId: ${realm.id}
groupIds:
- ${group.id}

Import

Default groups can be imported using the format {{realm_id}} where realm_id is the realm the group exists in. Example: bash

$ pulumi import keycloak:index/defaultGroups:DefaultGroups default my-realm

Constructors

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

Properties

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

A set of group ids that should be default groups on the realm referenced by realm_id.

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

The realm this group exists in.

Functions

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