Class DefaultGroups

# keycloak..DefaultGroups

Allows for managing a realm's default groups.

Note that you should not use keycloak..DefaultGroups with a group with memberships managed by keycloak..GroupMemberships.

Example Usage

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 @group = new Keycloak.Group("group", new Keycloak.GroupArgs
    {
        RealmId = realm.Id,
    });
    var @default = new Keycloak.DefaultGroups("default", new Keycloak.DefaultGroupsArgs
    {
        GroupIds = 
        {
            @group.Id,
        },
        RealmId = realm.Id,
    });
}

}

Argument Reference

The following arguments are supported:

• realm_id - (Required) The realm this group exists in.
• group_ids - (Required) A set of group ids that should be default groups on the realm referenced by realm_id.

Inheritance

System.Object

Resource

CustomResource

DefaultGroups

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak

Assembly: Pulumi.Keycloak.dll

Syntax

public class DefaultGroups : CustomResource

Constructors

DefaultGroups(String, DefaultGroupsArgs, CustomResourceOptions)

Create a DefaultGroups resource with the given unique name, arguments, and options.

Declaration

public DefaultGroups(string name, DefaultGroupsArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DefaultGroupsArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

GroupIds

Declaration

public Output<ImmutableArray<string>> GroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RealmId

Declaration

public Output<string> RealmId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, DefaultGroupsState, CustomResourceOptions)

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

Declaration

public static DefaultGroups Get(string name, Input<string> id, DefaultGroupsState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DefaultGroupsState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DefaultGroups