DefaultRoles

class DefaultRoles : KotlinCustomResource

Allows managing default realm roles within Keycloak. Note: This feature was added in Keycloak v13, so this resource will not work on older versions of Keycloak.

Example Usage

Realm Role)

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = new keycloak.Realm("realm", {
realm: "my-realm",
enabled: true,
});
const defaultRoles = new keycloak.DefaultRoles("default_roles", {
realmId: realm.id,
defaultRoles: ["uma_authorization"],
});
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
realm="my-realm",
enabled=True)
default_roles = keycloak.DefaultRoles("default_roles",
realm_id=realm.id,
default_roles=["uma_authorization"])
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 defaultRoles = new Keycloak.DefaultRoles("default_roles", new()
{
RealmId = realm.Id,
RoleNames = new[]
{
"uma_authorization",
},
});
});
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
}
_, err = keycloak.NewDefaultRoles(ctx, "default_roles", &keycloak.DefaultRolesArgs{
RealmId: realm.ID(),
DefaultRoles: pulumi.StringArray{
pulumi.String("uma_authorization"),
},
})
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.DefaultRoles;
import com.pulumi.keycloak.DefaultRolesArgs;
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 defaultRoles = new DefaultRoles("defaultRoles", DefaultRolesArgs.builder()
.realmId(realm.id())
.defaultRoles("uma_authorization")
.build());
}
}
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
defaultRoles:
type: keycloak:DefaultRoles
name: default_roles
properties:
realmId: ${realm.id}
defaultRoles:
- uma_authorization

Import

Default roles can be imported using the format {{realm_id}}/{{default_role_id}}, where default_role_id is the unique ID of the composite role that Keycloak uses to control default realm level roles. The ID is not easy to find in the GUI, but it appears in the dev tools when editing the default roles. Example: bash

$ pulumi import keycloak:index/defaultRoles:DefaultRoles default_roles my-realm/a04c35c2-e95a-4dc5-bd32-e83a21be9e7d

Properties

Link copied to clipboard
val defaultRoles: Output<List<String>>

Realm level roles assigned to new users by default.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val realmId: Output<String>

The realm this role exists within.

Link copied to clipboard
val urn: Output<String>