1. Packages
  2. Keycloak
  3. API Docs
  4. DefaultGroups
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi

keycloak.DefaultGroups

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi

    # 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

    import * as pulumi from "@pulumi/pulumi";
    import * as keycloak from "@pulumi/keycloak";
    
    const realm = new keycloak.Realm("realm", {
        enabled: true,
        realm: "my-realm",
    });
    const group = new keycloak.Group("group", {realmId: realm.id});
    const _default = new keycloak.DefaultGroups("default", {
        groupIds: [group.id],
        realmId: realm.id,
    });
    
    import pulumi
    import pulumi_keycloak as keycloak
    
    realm = keycloak.Realm("realm",
        enabled=True,
        realm="my-realm")
    group = keycloak.Group("group", realm_id=realm.id)
    default = keycloak.DefaultGroups("default",
        group_ids=[group.id],
        realm_id=realm.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-keycloak/sdk/v5/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{
    			Enabled: pulumi.Bool(true),
    			Realm:   pulumi.String("my-realm"),
    		})
    		if err != nil {
    			return err
    		}
    		group, err := keycloak.NewGroup(ctx, "group", &keycloak.GroupArgs{
    			RealmId: realm.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = keycloak.NewDefaultGroups(ctx, "default", &keycloak.DefaultGroupsArgs{
    			GroupIds: pulumi.StringArray{
    				group.ID(),
    			},
    			RealmId: realm.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Keycloak = Pulumi.Keycloak;
    
    return await Deployment.RunAsync(() => 
    {
        var realm = new Keycloak.Realm("realm", new()
        {
            Enabled = true,
            RealmName = "my-realm",
        });
    
        var @group = new Keycloak.Group("group", new()
        {
            RealmId = realm.Id,
        });
    
        var @default = new Keycloak.DefaultGroups("default", new()
        {
            GroupIds = new[]
            {
                @group.Id,
            },
            RealmId = realm.Id,
        });
    
    });
    
    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()        
                .enabled(true)
                .realm("my-realm")
                .build());
    
            var group = new Group("group", GroupArgs.builder()        
                .realmId(realm.id())
                .build());
    
            var default_ = new DefaultGroups("default", DefaultGroupsArgs.builder()        
                .groupIds(group.id())
                .realmId(realm.id())
                .build());
    
        }
    }
    
    resources:
      realm:
        type: keycloak:Realm
        properties:
          enabled: true
          realm: my-realm
      group:
        type: keycloak:Group
        properties:
          realmId: ${realm.id}
      default:
        type: keycloak:DefaultGroups
        properties:
          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.

    Import

    Groups can be imported using the format {{realm_id}} where realm_id is the realm the group exists in.

    Example:

    $ terraform import keycloak_default_groups.default my-realm
    

    Create DefaultGroups Resource

    new DefaultGroups(name: string, args: DefaultGroupsArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultGroups(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      group_ids: Optional[Sequence[str]] = None,
                      realm_id: Optional[str] = None)
    @overload
    def DefaultGroups(resource_name: str,
                      args: DefaultGroupsArgs,
                      opts: Optional[ResourceOptions] = None)
    func NewDefaultGroups(ctx *Context, name string, args DefaultGroupsArgs, opts ...ResourceOption) (*DefaultGroups, error)
    public DefaultGroups(string name, DefaultGroupsArgs args, CustomResourceOptions? opts = null)
    public DefaultGroups(String name, DefaultGroupsArgs args)
    public DefaultGroups(String name, DefaultGroupsArgs args, CustomResourceOptions options)
    
    type: keycloak:DefaultGroups
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DefaultGroupsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DefaultGroupsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DefaultGroupsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultGroupsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultGroupsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DefaultGroups Resource Properties

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

    Inputs

    The DefaultGroups resource accepts the following input properties:

    GroupIds List<string>
    RealmId string
    GroupIds []string
    RealmId string
    groupIds List<String>
    realmId String
    groupIds string[]
    realmId string
    group_ids Sequence[str]
    realm_id str
    groupIds List<String>
    realmId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DefaultGroups 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 DefaultGroups Resource

    Get an existing DefaultGroups 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?: DefaultGroupsState, opts?: CustomResourceOptions): DefaultGroups
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group_ids: Optional[Sequence[str]] = None,
            realm_id: Optional[str] = None) -> DefaultGroups
    func GetDefaultGroups(ctx *Context, name string, id IDInput, state *DefaultGroupsState, opts ...ResourceOption) (*DefaultGroups, error)
    public static DefaultGroups Get(string name, Input<string> id, DefaultGroupsState? state, CustomResourceOptions? opts = null)
    public static DefaultGroups get(String name, Output<String> id, DefaultGroupsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    GroupIds List<string>
    RealmId string
    GroupIds []string
    RealmId string
    groupIds List<String>
    realmId String
    groupIds string[]
    realmId string
    group_ids Sequence[str]
    realm_id str
    groupIds List<String>
    realmId String

    Package Details

    Repository
    Keycloak pulumi/pulumi-keycloak
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the keycloak Terraform Provider.
    keycloak logo
    Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi