Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. UserGroups
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.UserGroups

Explore with Pulumi AI

Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak

Allows for managing a Keycloak user’s groups.

If exhaustive is true, this resource attempts to be an authoritative source over user groups: groups that are manually added to the user will be removed, and groups that are manually removed from the user group will be added upon the next run of pulumi up. If exhaustive is false, this resource is a partial assignation of groups to a user. As a result, you can get multiple keycloak.UserGroups for the same user_id.

Example Usage

Exhaustive Groups)

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: "foo",
});
const user = new keycloak.User("user", {
    realmId: realm.id,
    username: "my-user",
});
const userGroups = new keycloak.UserGroups("user_groups", {
    realmId: realm.id,
    userId: user.id,
    groupIds: [group.id],
});
Copy
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="foo")
user = keycloak.User("user",
    realm_id=realm.id,
    username="my-user")
user_groups = keycloak.UserGroups("user_groups",
    realm_id=realm.id,
    user_id=user.id,
    group_ids=[group.id])
Copy
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("foo"),
		})
		if err != nil {
			return err
		}
		user, err := keycloak.NewUser(ctx, "user", &keycloak.UserArgs{
			RealmId:  realm.ID(),
			Username: pulumi.String("my-user"),
		})
		if err != nil {
			return err
		}
		_, err = keycloak.NewUserGroups(ctx, "user_groups", &keycloak.UserGroupsArgs{
			RealmId: realm.ID(),
			UserId:  user.ID(),
			GroupIds: pulumi.StringArray{
				group.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "foo",
    });

    var user = new Keycloak.User("user", new()
    {
        RealmId = realm.Id,
        Username = "my-user",
    });

    var userGroups = new Keycloak.UserGroups("user_groups", new()
    {
        RealmId = realm.Id,
        UserId = user.Id,
        GroupIds = new[]
        {
            @group.Id,
        },
    });

});
Copy
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.User;
import com.pulumi.keycloak.UserArgs;
import com.pulumi.keycloak.UserGroups;
import com.pulumi.keycloak.UserGroupsArgs;
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("foo")
            .build());

        var user = new User("user", UserArgs.builder()
            .realmId(realm.id())
            .username("my-user")
            .build());

        var userGroups = new UserGroups("userGroups", UserGroupsArgs.builder()
            .realmId(realm.id())
            .userId(user.id())
            .groupIds(group.id())
            .build());

    }
}
Copy
resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  group:
    type: keycloak:Group
    properties:
      realmId: ${realm.id}
      name: foo
  user:
    type: keycloak:User
    properties:
      realmId: ${realm.id}
      username: my-user
  userGroups:
    type: keycloak:UserGroups
    name: user_groups
    properties:
      realmId: ${realm.id}
      userId: ${user.id}
      groupIds:
        - ${group.id}
Copy

Create UserGroups Resource

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

Constructor syntax

new UserGroups(name: string, args: UserGroupsArgs, opts?: CustomResourceOptions);
@overload
def UserGroups(resource_name: str,
               args: UserGroupsArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def UserGroups(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               group_ids: Optional[Sequence[str]] = None,
               realm_id: Optional[str] = None,
               user_id: Optional[str] = None,
               exhaustive: Optional[bool] = None)
func NewUserGroups(ctx *Context, name string, args UserGroupsArgs, opts ...ResourceOption) (*UserGroups, error)
public UserGroups(string name, UserGroupsArgs args, CustomResourceOptions? opts = null)
public UserGroups(String name, UserGroupsArgs args)
public UserGroups(String name, UserGroupsArgs args, CustomResourceOptions options)

type: keycloak:UserGroups
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserGroupsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserGroupsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserGroupsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserGroupsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserGroupsArgs
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 userGroupsResource = new Keycloak.UserGroups("userGroupsResource", new()
{
    GroupIds = new[]
    {
        "string",
    },
    RealmId = "string",
    UserId = "string",
    Exhaustive = false,
});
Copy
example, err := keycloak.NewUserGroups(ctx, "userGroupsResource", &keycloak.UserGroupsArgs{
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	RealmId:    pulumi.String("string"),
	UserId:     pulumi.String("string"),
	Exhaustive: pulumi.Bool(false),
})
Copy
var userGroupsResource = new UserGroups("userGroupsResource", UserGroupsArgs.builder()
    .groupIds("string")
    .realmId("string")
    .userId("string")
    .exhaustive(false)
    .build());
Copy
user_groups_resource = keycloak.UserGroups("userGroupsResource",
    group_ids=["string"],
    realm_id="string",
    user_id="string",
    exhaustive=False)
Copy
const userGroupsResource = new keycloak.UserGroups("userGroupsResource", {
    groupIds: ["string"],
    realmId: "string",
    userId: "string",
    exhaustive: false,
});
Copy
type: keycloak:UserGroups
properties:
    exhaustive: false
    groupIds:
        - string
    realmId: string
    userId: string
Copy

UserGroups 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 UserGroups resource accepts the following input properties:

GroupIds This property is required. List<string>
A list of group IDs that the user is member of.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this group exists in.
UserId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the user this resource should manage groups for.
Exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
GroupIds This property is required. []string
A list of group IDs that the user is member of.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this group exists in.
UserId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the user this resource should manage groups for.
Exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds This property is required. List<String>
A list of group IDs that the user is member of.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this group exists in.
userId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the user this resource should manage groups for.
exhaustive Boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds This property is required. string[]
A list of group IDs that the user is member of.
realmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this group exists in.
userId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the user this resource should manage groups for.
exhaustive boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
group_ids This property is required. Sequence[str]
A list of group IDs that the user is member of.
realm_id
This property is required.
Changes to this property will trigger replacement.
str
The realm this group exists in.
user_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the user this resource should manage groups for.
exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds This property is required. List<String>
A list of group IDs that the user is member of.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this group exists in.
userId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the user this resource should manage groups for.
exhaustive Boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserGroups 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing UserGroups Resource

Get an existing UserGroups 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?: UserGroupsState, opts?: CustomResourceOptions): UserGroups
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        exhaustive: Optional[bool] = None,
        group_ids: Optional[Sequence[str]] = None,
        realm_id: Optional[str] = None,
        user_id: Optional[str] = None) -> UserGroups
func GetUserGroups(ctx *Context, name string, id IDInput, state *UserGroupsState, opts ...ResourceOption) (*UserGroups, error)
public static UserGroups Get(string name, Input<string> id, UserGroupsState? state, CustomResourceOptions? opts = null)
public static UserGroups get(String name, Output<String> id, UserGroupsState state, CustomResourceOptions options)
resources:  _:    type: keycloak:UserGroups    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
GroupIds List<string>
A list of group IDs that the user is member of.
RealmId Changes to this property will trigger replacement. string
The realm this group exists in.
UserId Changes to this property will trigger replacement. string
The ID of the user this resource should manage groups for.
Exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
GroupIds []string
A list of group IDs that the user is member of.
RealmId Changes to this property will trigger replacement. string
The realm this group exists in.
UserId Changes to this property will trigger replacement. string
The ID of the user this resource should manage groups for.
exhaustive Boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds List<String>
A list of group IDs that the user is member of.
realmId Changes to this property will trigger replacement. String
The realm this group exists in.
userId Changes to this property will trigger replacement. String
The ID of the user this resource should manage groups for.
exhaustive boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds string[]
A list of group IDs that the user is member of.
realmId Changes to this property will trigger replacement. string
The realm this group exists in.
userId Changes to this property will trigger replacement. string
The ID of the user this resource should manage groups for.
exhaustive bool
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
group_ids Sequence[str]
A list of group IDs that the user is member of.
realm_id Changes to this property will trigger replacement. str
The realm this group exists in.
user_id Changes to this property will trigger replacement. str
The ID of the user this resource should manage groups for.
exhaustive Boolean
Indicates if the list of the user's groups is exhaustive. In this case, groups that are manually added to the user will be removed. Defaults to true.
groupIds List<String>
A list of group IDs that the user is member of.
realmId Changes to this property will trigger replacement. String
The realm this group exists in.
userId Changes to this property will trigger replacement. String
The ID of the user this resource should manage groups for.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak