1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. Group

Group

# keycloak..Group

Allows for creating and managing Groups within Keycloak.

Groups provide a logical wrapping for users within Keycloak. Users within a group can share attributes and roles, and group membership can be mapped to a claim.

Attributes can also be defined on Groups.

Groups can also be federated from external data sources, such as LDAP or Active Directory. This resource should not be used to manage groups that were created this way.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const realm = new keycloak.Realm("realm", {
    enabled: true,
    realm: "my-realm",
});
const parentGroup = new keycloak.Group("parent_group", {
    realmId: realm.id,
});
const childGroup = new keycloak.Group("child_group", {
    parentId: parentGroup.id,
    realmId: realm.id,
});
const childGroupWithOptionalAttributes = new keycloak.Group("child_group_with_optional_attributes", {
    attributes: {
        key1: "value1",
        key2: "value2",
    },
    parentId: parentGroup.id,
    realmId: realm.id,
});
import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    enabled=True,
    realm="my-realm")
parent_group = keycloak.Group("parentGroup", realm_id=realm.id)
child_group = keycloak.Group("childGroup",
    parent_id=parent_group.id,
    realm_id=realm.id)
child_group_with_optional_attributes = keycloak.Group("childGroupWithOptionalAttributes",
    attributes={
        "key1": "value1",
        "key2": "value2",
    },
    parent_id=parent_group.id,
    realm_id=realm.id)
using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
        {
            Enabled = true,
            Realm = "my-realm",
        });
        var parentGroup = new Keycloak.Group("parentGroup", new Keycloak.GroupArgs
        {
            RealmId = realm.Id,
        });
        var childGroup = new Keycloak.Group("childGroup", new Keycloak.GroupArgs
        {
            ParentId = parentGroup.Id,
            RealmId = realm.Id,
        });
        var childGroupWithOptionalAttributes = new Keycloak.Group("childGroupWithOptionalAttributes", new Keycloak.GroupArgs
        {
            Attributes = 
            {
                { "key1", "value1" },
                { "key2", "value2" },
            },
            ParentId = parentGroup.Id,
            RealmId = realm.Id,
        });
    }

}

Argument Reference

The following arguments are supported:

  • realm_id - (Required) The realm this group exists in.
  • parent_id - (Optional) The ID of this group’s parent. If omitted, this group will be defined at the root level.
  • name - (Required) The name of the group.
  • attributes - (Optional) A dict of key/value pairs to set as custom attributes for the group.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • path - The complete path of the group. For example, the child group’s path in the example configuration would be /parent-group/child-group.

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
def Group(resource_name, opts=None, attributes=None, name=None, parent_id=None, realm_id=None, __props__=None);
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Group Resource Properties

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

Inputs

The Group resource accepts the following input properties:

RealmId string
Attributes Dictionary<string, object>
Name string
ParentId string
RealmId string
Attributes map[string]interface{}
Name string
ParentId string
realmId string
attributes {[key: string]: any}
name string
parentId string
realm_id str
attributes Dict[str, Any]
name str
parent_id str

Outputs

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

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

Look up an Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
static get(resource_name, id, opts=None, attributes=None, name=None, parent_id=None, path=None, realm_id=None, __props__=None);
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Attributes Dictionary<string, object>
Name string
ParentId string
Path string
RealmId string
Attributes map[string]interface{}
Name string
ParentId string
Path string
RealmId string
attributes {[key: string]: any}
name string
parentId string
path string
realmId string
attributes Dict[str, Any]
name str
parent_id str
path str
realm_id str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.