1. Packages
  2. Packages
  3. Keycloak Provider
  4. API Docs
  5. UsersAdminPermissions
Viewing docs for Keycloak v6.13.0
published on Saturday, Aug 1, 2026 by Pulumi
keycloak logo keycloak logo
Viewing docs for Keycloak v6.13.0
published on Saturday, Aug 1, 2026 by Pulumi

    Allows you to manage a fine-grained admin permission for all users in a Keycloak realm.

    This resource requires Fine-Grained Admin Permissions v2 (admin-fine-grained-authz:v2), available since Keycloak 26.2. See the docker-compose.yml for an example of how to enable this feature.

    Each instance of this resource represents one permission in Keycloak. User permissions in FGAPv2 are always realm-wide — they apply to all users in the realm (there is no per-user targeting).

    When adminPermissionsEnabled = true is set on the realm, Keycloak automatically creates an admin-permissions client that serves as the authorization resource server for all FGAPv2 admin permissions.

    Available scopes:

    • view — list and view user details
    • manage — create, update, and delete users
    • map-roles — assign or remove realm roles on users
    • manage-group-membership — add or remove users from groups
    • impersonate — impersonate a user

    Note: The user-impersonated scope from v1 (keycloak.UsersPermissions) has no equivalent in FGAPv2 and is not available in this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as keycloak from "@pulumi/keycloak";
    
    const realm = new keycloak.Realm("realm", {
        realm: "my-realm",
        adminPermissionsEnabled: true,
    });
    const adminPermissions = keycloak.openid.getClientOutput({
        realmId: realm.id,
        clientId: "admin-permissions",
    });
    const admins = new keycloak.Group("admins", {
        realmId: realm.id,
        name: "admins",
    });
    const auditors = new keycloak.Group("auditors", {
        realmId: realm.id,
        name: "auditors",
    });
    const adminsPolicy = new keycloak.openid.ClientGroupPolicy("admins_policy", {
        realmId: realm.id,
        resourceServerId: adminPermissions.apply(adminPermissions => adminPermissions.id),
        name: "admins-policy",
        groups: [{
            id: admins.id,
            path: admins.path,
            extendChildren: false,
        }],
        logic: "POSITIVE",
        decisionStrategy: "UNANIMOUS",
    });
    const auditorsPolicy = new keycloak.openid.ClientGroupPolicy("auditors_policy", {
        realmId: realm.id,
        resourceServerId: adminPermissions.apply(adminPermissions => adminPermissions.id),
        name: "auditors-policy",
        groups: [{
            id: auditors.id,
            path: auditors.path,
            extendChildren: false,
        }],
        logic: "POSITIVE",
        decisionStrategy: "UNANIMOUS",
    });
    // One permission per logical role — each is a separate Terraform resource.
    const adminsManageUsers = new keycloak.UsersAdminPermissions("admins_manage_users", {
        realmId: realm.id,
        name: "admins-can-manage-users",
        description: "Admins can view and manage all users",
        decisionStrategy: "UNANIMOUS",
        scopes: [
            "view",
            "manage",
        ],
        policies: [adminsPolicy.id],
    });
    const auditorsViewUsers = new keycloak.UsersAdminPermissions("auditors_view_users", {
        realmId: realm.id,
        name: "auditors-can-view-users",
        description: "Auditors can view all users",
        scopes: ["view"],
        policies: [auditorsPolicy.id],
    });
    
    import pulumi
    import pulumi_keycloak as keycloak
    
    realm = keycloak.Realm("realm",
        realm="my-realm",
        admin_permissions_enabled=True)
    admin_permissions = keycloak.openid.get_client_output(realm_id=realm.id,
        client_id="admin-permissions")
    admins = keycloak.Group("admins",
        realm_id=realm.id,
        name="admins")
    auditors = keycloak.Group("auditors",
        realm_id=realm.id,
        name="auditors")
    admins_policy = keycloak.openid.ClientGroupPolicy("admins_policy",
        realm_id=realm.id,
        resource_server_id=admin_permissions.id,
        name="admins-policy",
        groups=[{
            "id": admins.id,
            "path": admins.path,
            "extend_children": False,
        }],
        logic="POSITIVE",
        decision_strategy="UNANIMOUS")
    auditors_policy = keycloak.openid.ClientGroupPolicy("auditors_policy",
        realm_id=realm.id,
        resource_server_id=admin_permissions.id,
        name="auditors-policy",
        groups=[{
            "id": auditors.id,
            "path": auditors.path,
            "extend_children": False,
        }],
        logic="POSITIVE",
        decision_strategy="UNANIMOUS")
    # One permission per logical role — each is a separate Terraform resource.
    admins_manage_users = keycloak.UsersAdminPermissions("admins_manage_users",
        realm_id=realm.id,
        name="admins-can-manage-users",
        description="Admins can view and manage all users",
        decision_strategy="UNANIMOUS",
        scopes=[
            "view",
            "manage",
        ],
        policies=[admins_policy.id])
    auditors_view_users = keycloak.UsersAdminPermissions("auditors_view_users",
        realm_id=realm.id,
        name="auditors-can-view-users",
        description="Auditors can view all users",
        scopes=["view"],
        policies=[auditors_policy.id])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
    	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak/openid"
    	"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"),
    			AdminPermissionsEnabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		adminPermissions := openid.LookupClientOutput(ctx, openid.GetClientOutputArgs{
    			RealmId:  realm.ID(),
    			ClientId: pulumi.String("admin-permissions"),
    		}, nil)
    		admins, err := keycloak.NewGroup(ctx, "admins", &keycloak.GroupArgs{
    			RealmId: realm.ID(),
    			Name:    pulumi.String("admins"),
    		})
    		if err != nil {
    			return err
    		}
    		auditors, err := keycloak.NewGroup(ctx, "auditors", &keycloak.GroupArgs{
    			RealmId: realm.ID(),
    			Name:    pulumi.String("auditors"),
    		})
    		if err != nil {
    			return err
    		}
    		adminsPolicy, err := openid.NewClientGroupPolicy(ctx, "admins_policy", &openid.ClientGroupPolicyArgs{
    			RealmId: realm.ID(),
    			ResourceServerId: pulumi.String(adminPermissions.ApplyT(func(adminPermissions openid.GetClientResult) (*string, error) {
    				return adminPermissions.Id, nil
    			}).(pulumi.StringPtrOutput)),
    			Name: pulumi.String("admins-policy"),
    			Groups: openid.ClientGroupPolicyGroupArray{
    				&openid.ClientGroupPolicyGroupArgs{
    					Id:             admins.ID(),
    					Path:           admins.Path,
    					ExtendChildren: pulumi.Bool(false),
    				},
    			},
    			Logic:            pulumi.String("POSITIVE"),
    			DecisionStrategy: pulumi.String("UNANIMOUS"),
    		})
    		if err != nil {
    			return err
    		}
    		auditorsPolicy, err := openid.NewClientGroupPolicy(ctx, "auditors_policy", &openid.ClientGroupPolicyArgs{
    			RealmId: realm.ID(),
    			ResourceServerId: pulumi.String(adminPermissions.ApplyT(func(adminPermissions openid.GetClientResult) (*string, error) {
    				return adminPermissions.Id, nil
    			}).(pulumi.StringPtrOutput)),
    			Name: pulumi.String("auditors-policy"),
    			Groups: openid.ClientGroupPolicyGroupArray{
    				&openid.ClientGroupPolicyGroupArgs{
    					Id:             auditors.ID(),
    					Path:           auditors.Path,
    					ExtendChildren: pulumi.Bool(false),
    				},
    			},
    			Logic:            pulumi.String("POSITIVE"),
    			DecisionStrategy: pulumi.String("UNANIMOUS"),
    		})
    		if err != nil {
    			return err
    		}
    		// One permission per logical role — each is a separate Terraform resource.
    		_, err = keycloak.NewUsersAdminPermissions(ctx, "admins_manage_users", &keycloak.UsersAdminPermissionsArgs{
    			RealmId:          realm.ID(),
    			Name:             pulumi.String("admins-can-manage-users"),
    			Description:      pulumi.String("Admins can view and manage all users"),
    			DecisionStrategy: pulumi.String("UNANIMOUS"),
    			Scopes: pulumi.StringArray{
    				pulumi.String("view"),
    				pulumi.String("manage"),
    			},
    			Policies: pulumi.StringArray{
    				adminsPolicy.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = keycloak.NewUsersAdminPermissions(ctx, "auditors_view_users", &keycloak.UsersAdminPermissionsArgs{
    			RealmId:     realm.ID(),
    			Name:        pulumi.String("auditors-can-view-users"),
    			Description: pulumi.String("Auditors can view all users"),
    			Scopes: pulumi.StringArray{
    				pulumi.String("view"),
    			},
    			Policies: pulumi.StringArray{
    				auditorsPolicy.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()
        {
            RealmName = "my-realm",
            AdminPermissionsEnabled = true,
        });
    
        var adminPermissions = Keycloak.OpenId.GetClient.Invoke(new()
        {
            RealmId = realm.Id,
            ClientId = "admin-permissions",
        });
    
        var admins = new Keycloak.Group("admins", new()
        {
            RealmId = realm.Id,
            Name = "admins",
        });
    
        var auditors = new Keycloak.Group("auditors", new()
        {
            RealmId = realm.Id,
            Name = "auditors",
        });
    
        var adminsPolicy = new Keycloak.OpenId.ClientGroupPolicy("admins_policy", new()
        {
            RealmId = realm.Id,
            ResourceServerId = adminPermissions.Apply(getClientResult => getClientResult.Id),
            Name = "admins-policy",
            Groups = new[]
            {
                new Keycloak.OpenId.Inputs.ClientGroupPolicyGroupArgs
                {
                    Id = admins.Id,
                    Path = admins.Path,
                    ExtendChildren = false,
                },
            },
            Logic = "POSITIVE",
            DecisionStrategy = "UNANIMOUS",
        });
    
        var auditorsPolicy = new Keycloak.OpenId.ClientGroupPolicy("auditors_policy", new()
        {
            RealmId = realm.Id,
            ResourceServerId = adminPermissions.Apply(getClientResult => getClientResult.Id),
            Name = "auditors-policy",
            Groups = new[]
            {
                new Keycloak.OpenId.Inputs.ClientGroupPolicyGroupArgs
                {
                    Id = auditors.Id,
                    Path = auditors.Path,
                    ExtendChildren = false,
                },
            },
            Logic = "POSITIVE",
            DecisionStrategy = "UNANIMOUS",
        });
    
        // One permission per logical role — each is a separate Terraform resource.
        var adminsManageUsers = new Keycloak.UsersAdminPermissions("admins_manage_users", new()
        {
            RealmId = realm.Id,
            Name = "admins-can-manage-users",
            Description = "Admins can view and manage all users",
            DecisionStrategy = "UNANIMOUS",
            Scopes = new[]
            {
                "view",
                "manage",
            },
            Policies = new[]
            {
                adminsPolicy.Id,
            },
        });
    
        var auditorsViewUsers = new Keycloak.UsersAdminPermissions("auditors_view_users", new()
        {
            RealmId = realm.Id,
            Name = "auditors-can-view-users",
            Description = "Auditors can view all users",
            Scopes = new[]
            {
                "view",
            },
            Policies = new[]
            {
                auditorsPolicy.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.openid.OpenidFunctions;
    import com.pulumi.keycloak.openid.inputs.GetClientArgs;
    import com.pulumi.keycloak.Group;
    import com.pulumi.keycloak.GroupArgs;
    import com.pulumi.keycloak.openid.ClientGroupPolicy;
    import com.pulumi.keycloak.openid.ClientGroupPolicyArgs;
    import com.pulumi.keycloak.openid.inputs.ClientGroupPolicyGroupArgs;
    import com.pulumi.keycloak.UsersAdminPermissions;
    import com.pulumi.keycloak.UsersAdminPermissionsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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")
                .adminPermissionsEnabled(true)
                .build());
    
            final var adminPermissions = OpenidFunctions.getClient(GetClientArgs.builder()
                .realmId(realm.id())
                .clientId("admin-permissions")
                .build());
    
            var admins = new Group("admins", GroupArgs.builder()
                .realmId(realm.id())
                .name("admins")
                .build());
    
            var auditors = new Group("auditors", GroupArgs.builder()
                .realmId(realm.id())
                .name("auditors")
                .build());
    
            var adminsPolicy = new ClientGroupPolicy("adminsPolicy", ClientGroupPolicyArgs.builder()
                .realmId(realm.id())
                .resourceServerId(adminPermissions.applyValue(_adminPermissions -> _adminPermissions.id()))
                .name("admins-policy")
                .groups(ClientGroupPolicyGroupArgs.builder()
                    .id(admins.id())
                    .path(admins.path())
                    .extendChildren(false)
                    .build())
                .logic("POSITIVE")
                .decisionStrategy("UNANIMOUS")
                .build());
    
            var auditorsPolicy = new ClientGroupPolicy("auditorsPolicy", ClientGroupPolicyArgs.builder()
                .realmId(realm.id())
                .resourceServerId(adminPermissions.applyValue(_adminPermissions -> _adminPermissions.id()))
                .name("auditors-policy")
                .groups(ClientGroupPolicyGroupArgs.builder()
                    .id(auditors.id())
                    .path(auditors.path())
                    .extendChildren(false)
                    .build())
                .logic("POSITIVE")
                .decisionStrategy("UNANIMOUS")
                .build());
    
            // One permission per logical role — each is a separate Terraform resource.
            var adminsManageUsers = new UsersAdminPermissions("adminsManageUsers", UsersAdminPermissionsArgs.builder()
                .realmId(realm.id())
                .name("admins-can-manage-users")
                .description("Admins can view and manage all users")
                .decisionStrategy("UNANIMOUS")
                .scopes(            
                    "view",
                    "manage")
                .policies(adminsPolicy.id())
                .build());
    
            var auditorsViewUsers = new UsersAdminPermissions("auditorsViewUsers", UsersAdminPermissionsArgs.builder()
                .realmId(realm.id())
                .name("auditors-can-view-users")
                .description("Auditors can view all users")
                .scopes("view")
                .policies(auditorsPolicy.id())
                .build());
    
        }
    }
    
    resources:
      realm:
        type: keycloak:Realm
        properties:
          realm: my-realm
          adminPermissionsEnabled: true
      admins:
        type: keycloak:Group
        properties:
          realmId: ${realm.id}
          name: admins
      auditors:
        type: keycloak:Group
        properties:
          realmId: ${realm.id}
          name: auditors
      adminsPolicy:
        type: keycloak:openid:ClientGroupPolicy
        name: admins_policy
        properties:
          realmId: ${realm.id}
          resourceServerId: ${adminPermissions.id}
          name: admins-policy
          groups:
            - id: ${admins.id}
              path: ${admins.path}
              extendChildren: false
          logic: POSITIVE
          decisionStrategy: UNANIMOUS
      auditorsPolicy:
        type: keycloak:openid:ClientGroupPolicy
        name: auditors_policy
        properties:
          realmId: ${realm.id}
          resourceServerId: ${adminPermissions.id}
          name: auditors-policy
          groups:
            - id: ${auditors.id}
              path: ${auditors.path}
              extendChildren: false
          logic: POSITIVE
          decisionStrategy: UNANIMOUS
      # One permission per logical role — each is a separate Terraform resource.
      adminsManageUsers:
        type: keycloak:UsersAdminPermissions
        name: admins_manage_users
        properties:
          realmId: ${realm.id}
          name: admins-can-manage-users
          description: Admins can view and manage all users
          decisionStrategy: UNANIMOUS
          scopes:
            - view
            - manage
          policies:
            - ${adminsPolicy.id}
      auditorsViewUsers:
        type: keycloak:UsersAdminPermissions
        name: auditors_view_users
        properties:
          realmId: ${realm.id}
          name: auditors-can-view-users
          description: Auditors can view all users
          scopes:
            - view
          policies:
            - ${auditorsPolicy.id}
    variables:
      adminPermissions:
        fn::invoke:
          function: keycloak:openid:getClient
          arguments:
            realmId: ${realm.id}
            clientId: admin-permissions
    
    pulumi {
      required_providers {
        keycloak = {
          source = "pulumi/keycloak"
        }
      }
    }
    
    data "keycloak_openid_getclient" "adminPermissions" {
      realm_id  = keycloak_realm.realm.id
      client_id = "admin-permissions"
    }
    
    resource "keycloak_realm" "realm" {
      realm                     = "my-realm"
      admin_permissions_enabled = true
    }
    resource "keycloak_group" "admins" {
      realm_id = keycloak_realm.realm.id
      name     = "admins"
    }
    resource "keycloak_group" "auditors" {
      realm_id = keycloak_realm.realm.id
      name     = "auditors"
    }
    resource "keycloak_openid_clientgrouppolicy" "admins_policy" {
      realm_id           = keycloak_realm.realm.id
      resource_server_id = data.keycloak_openid_getclient.adminPermissions.id
      name               = "admins-policy"
      groups {
        id              = keycloak_group.admins.id
        path            = keycloak_group.admins.path
        extend_children = false
      }
      logic             = "POSITIVE"
      decision_strategy = "UNANIMOUS"
    }
    resource "keycloak_openid_clientgrouppolicy" "auditors_policy" {
      realm_id           = keycloak_realm.realm.id
      resource_server_id = data.keycloak_openid_getclient.adminPermissions.id
      name               = "auditors-policy"
      groups {
        id              = keycloak_group.auditors.id
        path            = keycloak_group.auditors.path
        extend_children = false
      }
      logic             = "POSITIVE"
      decision_strategy = "UNANIMOUS"
    }
    # One permission per logical role — each is a separate Terraform resource.
    resource "keycloak_usersadminpermissions" "admins_manage_users" {
      realm_id          = keycloak_realm.realm.id
      name              = "admins-can-manage-users"
      description       = "Admins can view and manage all users"
      decision_strategy = "UNANIMOUS"
      scopes            = ["view", "manage"]
      policies          = [keycloak_openid_clientgrouppolicy.admins_policy.id]
    }
    resource "keycloak_usersadminpermissions" "auditors_view_users" {
      realm_id    = keycloak_realm.realm.id
      name        = "auditors-can-view-users"
      description = "Auditors can view all users"
      scopes      = ["view"]
      policies    = [keycloak_openid_clientgrouppolicy.auditors_policy.id]
    }
    

    Create UsersAdminPermissions Resource

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

    Constructor syntax

    new UsersAdminPermissions(name: string, args: UsersAdminPermissionsArgs, opts?: CustomResourceOptions);
    @overload
    def UsersAdminPermissions(resource_name: str,
                              args: UsersAdminPermissionsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def UsersAdminPermissions(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              realm_id: Optional[str] = None,
                              scopes: Optional[Sequence[str]] = None,
                              decision_strategy: Optional[str] = None,
                              description: Optional[str] = None,
                              name: Optional[str] = None,
                              policies: Optional[Sequence[str]] = None)
    func NewUsersAdminPermissions(ctx *Context, name string, args UsersAdminPermissionsArgs, opts ...ResourceOption) (*UsersAdminPermissions, error)
    public UsersAdminPermissions(string name, UsersAdminPermissionsArgs args, CustomResourceOptions? opts = null)
    public UsersAdminPermissions(String name, UsersAdminPermissionsArgs args)
    public UsersAdminPermissions(String name, UsersAdminPermissionsArgs args, CustomResourceOptions options)
    
    type: keycloak:UsersAdminPermissions
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "keycloak_users_admin_permissions" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UsersAdminPermissionsArgs
    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 UsersAdminPermissionsArgs
    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 UsersAdminPermissionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsersAdminPermissionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsersAdminPermissionsArgs
    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 usersAdminPermissionsResource = new Keycloak.UsersAdminPermissions("usersAdminPermissionsResource", new()
    {
        RealmId = "string",
        Scopes = new[]
        {
            "string",
        },
        DecisionStrategy = "string",
        Description = "string",
        Name = "string",
        Policies = new[]
        {
            "string",
        },
    });
    
    example, err := keycloak.NewUsersAdminPermissions(ctx, "usersAdminPermissionsResource", &keycloak.UsersAdminPermissionsArgs{
    	RealmId: pulumi.String("string"),
    	Scopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DecisionStrategy: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Policies: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "keycloak_users_admin_permissions" "usersAdminPermissionsResource" {
      lifecycle {
        create_before_destroy = true
      }
      realm_id          = "string"
      scopes            = ["string"]
      decision_strategy = "string"
      description       = "string"
      name              = "string"
      policies          = ["string"]
    }
    
    var usersAdminPermissionsResource = new UsersAdminPermissions("usersAdminPermissionsResource", UsersAdminPermissionsArgs.builder()
        .realmId("string")
        .scopes("string")
        .decisionStrategy("string")
        .description("string")
        .name("string")
        .policies("string")
        .build());
    
    users_admin_permissions_resource = keycloak.UsersAdminPermissions("usersAdminPermissionsResource",
        realm_id="string",
        scopes=["string"],
        decision_strategy="string",
        description="string",
        name="string",
        policies=["string"])
    
    const usersAdminPermissionsResource = new keycloak.UsersAdminPermissions("usersAdminPermissionsResource", {
        realmId: "string",
        scopes: ["string"],
        decisionStrategy: "string",
        description: "string",
        name: "string",
        policies: ["string"],
    });
    
    type: keycloak:UsersAdminPermissions
    properties:
        decisionStrategy: string
        description: string
        name: string
        policies:
            - string
        realmId: string
        scopes:
            - string
    

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

    RealmId string
    The realm in which to manage this permission.
    Scopes List<string>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    DecisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    Description string
    Description of the permission.
    Name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    Policies List<string>
    Set of policy IDs to attach to the permission.
    RealmId string
    The realm in which to manage this permission.
    Scopes []string
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    DecisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    Description string
    Description of the permission.
    Name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    Policies []string
    Set of policy IDs to attach to the permission.
    realm_id string
    The realm in which to manage this permission.
    scopes list(string)
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    decision_strategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description string
    Description of the permission.
    name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    policies list(string)
    Set of policy IDs to attach to the permission.
    realmId String
    The realm in which to manage this permission.
    scopes List<String>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    decisionStrategy String
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description String
    Description of the permission.
    name String
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    policies List<String>
    Set of policy IDs to attach to the permission.
    realmId string
    The realm in which to manage this permission.
    scopes string[]
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    decisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description string
    Description of the permission.
    name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    policies string[]
    Set of policy IDs to attach to the permission.
    realm_id str
    The realm in which to manage this permission.
    scopes Sequence[str]
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    decision_strategy str
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description str
    Description of the permission.
    name str
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    policies Sequence[str]
    Set of policy IDs to attach to the permission.
    realmId String
    The realm in which to manage this permission.
    scopes List<String>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    decisionStrategy String
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description String
    Description of the permission.
    name String
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    policies List<String>
    Set of policy IDs to attach to the permission.

    Outputs

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

    AuthorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    Enabled bool
    Always true when the resource exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    PermissionId string
    The internal Keycloak UUID of the permission.
    AuthorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    Enabled bool
    Always true when the resource exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    PermissionId string
    The internal Keycloak UUID of the permission.
    authorization_resource_server_id string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    enabled bool
    Always true when the resource exists.
    id string
    The provider-assigned unique ID for this managed resource.
    permission_id string
    The internal Keycloak UUID of the permission.
    authorizationResourceServerId String
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    enabled Boolean
    Always true when the resource exists.
    id String
    The provider-assigned unique ID for this managed resource.
    permissionId String
    The internal Keycloak UUID of the permission.
    authorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    enabled boolean
    Always true when the resource exists.
    id string
    The provider-assigned unique ID for this managed resource.
    permissionId string
    The internal Keycloak UUID of the permission.
    authorization_resource_server_id str
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    enabled bool
    Always true when the resource exists.
    id str
    The provider-assigned unique ID for this managed resource.
    permission_id str
    The internal Keycloak UUID of the permission.
    authorizationResourceServerId String
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    enabled Boolean
    Always true when the resource exists.
    id String
    The provider-assigned unique ID for this managed resource.
    permissionId String
    The internal Keycloak UUID of the permission.

    Look up Existing UsersAdminPermissions Resource

    Get an existing UsersAdminPermissions 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?: UsersAdminPermissionsState, opts?: CustomResourceOptions): UsersAdminPermissions
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorization_resource_server_id: Optional[str] = None,
            decision_strategy: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            permission_id: Optional[str] = None,
            policies: Optional[Sequence[str]] = None,
            realm_id: Optional[str] = None,
            scopes: Optional[Sequence[str]] = None) -> UsersAdminPermissions
    func GetUsersAdminPermissions(ctx *Context, name string, id IDInput, state *UsersAdminPermissionsState, opts ...ResourceOption) (*UsersAdminPermissions, error)
    public static UsersAdminPermissions Get(string name, Input<string> id, UsersAdminPermissionsState? state, CustomResourceOptions? opts = null)
    public static UsersAdminPermissions get(String name, Output<String> id, UsersAdminPermissionsState state, CustomResourceOptions options)
    resources:  _:    type: keycloak:UsersAdminPermissions    get:      id: ${id}
    import {
      to = keycloak_users_admin_permissions.example
      id = "${id}"
    }
    
    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:
    AuthorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    DecisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    Description string
    Description of the permission.
    Enabled bool
    Always true when the resource exists.
    Name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    PermissionId string
    The internal Keycloak UUID of the permission.
    Policies List<string>
    Set of policy IDs to attach to the permission.
    RealmId string
    The realm in which to manage this permission.
    Scopes List<string>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    AuthorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    DecisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    Description string
    Description of the permission.
    Enabled bool
    Always true when the resource exists.
    Name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    PermissionId string
    The internal Keycloak UUID of the permission.
    Policies []string
    Set of policy IDs to attach to the permission.
    RealmId string
    The realm in which to manage this permission.
    Scopes []string
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    authorization_resource_server_id string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    decision_strategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description string
    Description of the permission.
    enabled bool
    Always true when the resource exists.
    name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    permission_id string
    The internal Keycloak UUID of the permission.
    policies list(string)
    Set of policy IDs to attach to the permission.
    realm_id string
    The realm in which to manage this permission.
    scopes list(string)
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    authorizationResourceServerId String
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    decisionStrategy String
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description String
    Description of the permission.
    enabled Boolean
    Always true when the resource exists.
    name String
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    permissionId String
    The internal Keycloak UUID of the permission.
    policies List<String>
    Set of policy IDs to attach to the permission.
    realmId String
    The realm in which to manage this permission.
    scopes List<String>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    authorizationResourceServerId string
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    decisionStrategy string
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description string
    Description of the permission.
    enabled boolean
    Always true when the resource exists.
    name string
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    permissionId string
    The internal Keycloak UUID of the permission.
    policies string[]
    Set of policy IDs to attach to the permission.
    realmId string
    The realm in which to manage this permission.
    scopes string[]
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    authorization_resource_server_id str
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    decision_strategy str
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description str
    Description of the permission.
    enabled bool
    Always true when the resource exists.
    name str
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    permission_id str
    The internal Keycloak UUID of the permission.
    policies Sequence[str]
    Set of policy IDs to attach to the permission.
    realm_id str
    The realm in which to manage this permission.
    scopes Sequence[str]
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.
    authorizationResourceServerId String
    The ID of the admin-permissions client, which acts as the resource server for these permissions.
    decisionStrategy String
    Decision strategy. One of UNANIMOUS, AFFIRMATIVE, or CONSENSUS. Defaults to UNANIMOUS.
    description String
    Description of the permission.
    enabled Boolean
    Always true when the resource exists.
    name String
    The name of the permission. Must be unique within the admin-permissions resource server. On first apply, if a permission with this name already exists it is adopted; otherwise a new one is created.
    permissionId String
    The internal Keycloak UUID of the permission.
    policies List<String>
    Set of policy IDs to attach to the permission.
    realmId String
    The realm in which to manage this permission.
    scopes List<String>
    Set of scopes this permission grants. Valid values: view, manage, map-roles, manage-group-membership, impersonate.

    Import

    Users admin permissions can be imported using {{realmId}}/{{permissionId}}:

    $ pulumi import keycloak:index/usersAdminPermissions:UsersAdminPermissions example my-realm/permission-uuid
    

    After import, run pulumi up to reconcile scopes and policies with your configuration.

    To learn more about importing existing cloud resources, see Importing resources.

    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 logo
    Viewing docs for Keycloak v6.13.0
    published on Saturday, Aug 1, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial