1. Packages
  2. Keycloak Provider
  3. API Docs
  4. openid
  5. ClientUserPolicy
Keycloak v6.10.0 published on Saturday, Feb 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-keycloak

keycloak.openid.ClientUserPolicy

keycloak logo
Keycloak v6.10.0 published on Saturday, Feb 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-keycloak

    Allows you to manage user policies.

    User policies allow you to define conditions based on specific users. This is useful when you need to grant access to individual users rather than based on roles or groups.

    Example Usage

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

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const test = new keycloak.openid.Client("test", {
    clientId: "client_id",
    realmId: realm.id,
    accessType: "CONFIDENTIAL",
    serviceAccountsEnabled: true,
    authorization: {
        policyEnforcementMode: "ENFORCING",
    },
});
const alice = new keycloak.User("alice", {
    realmId: realm.id,
    username: "alice",
    enabled: true,
    email: "alice@example.com",
    firstName: "Alice",
    lastName: "Smith",
});
const bob = new keycloak.User("bob", {
    realmId: realm.id,
    username: "bob",
    enabled: true,
    email: "bob@example.com",
    firstName: "Bob",
    lastName: "Jones",
});
const testClientUserPolicy = new keycloak.openid.ClientUserPolicy("test", {
    resourceServerId: test.resourceServerId,
    realmId: realm.id,
    name: "user_policy",
    decisionStrategy: "UNANIMOUS",
    logic: "POSITIVE",
    users: [
        alice.id,
        bob.id,
    ],
});

    import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
test = keycloak.openid.Client("test",
    client_id="client_id",
    realm_id=realm.id,
    access_type="CONFIDENTIAL",
    service_accounts_enabled=True,
    authorization={
        "policy_enforcement_mode": "ENFORCING",
    })
alice = keycloak.User("alice",
    realm_id=realm.id,
    username="alice",
    enabled=True,
    email="alice@example.com",
    first_name="Alice",
    last_name="Smith")
bob = keycloak.User("bob",
    realm_id=realm.id,
    username="bob",
    enabled=True,
    email="bob@example.com",
    first_name="Bob",
    last_name="Jones")
test_client_user_policy = keycloak.openid.ClientUserPolicy("test",
    resource_server_id=test.resource_server_id,
    realm_id=realm.id,
    name="user_policy",
    decision_strategy="UNANIMOUS",
    logic="POSITIVE",
    users=[
        alice.id,
        bob.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"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		test, err := openid.NewClient(ctx, "test", &openid.ClientArgs{
			ClientId:               pulumi.String("client_id"),
			RealmId:                realm.ID(),
			AccessType:             pulumi.String("CONFIDENTIAL"),
			ServiceAccountsEnabled: pulumi.Bool(true),
			Authorization: &openid.ClientAuthorizationArgs{
				PolicyEnforcementMode: pulumi.String("ENFORCING"),
			},
		})
		if err != nil {
			return err
		}
		alice, err := keycloak.NewUser(ctx, "alice", &keycloak.UserArgs{
			RealmId:   realm.ID(),
			Username:  pulumi.String("alice"),
			Enabled:   pulumi.Bool(true),
			Email:     pulumi.String("alice@example.com"),
			FirstName: pulumi.String("Alice"),
			LastName:  pulumi.String("Smith"),
		})
		if err != nil {
			return err
		}
		bob, err := keycloak.NewUser(ctx, "bob", &keycloak.UserArgs{
			RealmId:   realm.ID(),
			Username:  pulumi.String("bob"),
			Enabled:   pulumi.Bool(true),
			Email:     pulumi.String("bob@example.com"),
			FirstName: pulumi.String("Bob"),
			LastName:  pulumi.String("Jones"),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewClientUserPolicy(ctx, "test", &openid.ClientUserPolicyArgs{
			ResourceServerId: test.ResourceServerId,
			RealmId:          realm.ID(),
			Name:             pulumi.String("user_policy"),
			DecisionStrategy: pulumi.String("UNANIMOUS"),
			Logic:            pulumi.String("POSITIVE"),
			Users: pulumi.StringArray{
				alice.ID(),
				bob.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",
        Enabled = true,
    });

    var test = new Keycloak.OpenId.Client("test", new()
    {
        ClientId = "client_id",
        RealmId = realm.Id,
        AccessType = "CONFIDENTIAL",
        ServiceAccountsEnabled = true,
        Authorization = new Keycloak.OpenId.Inputs.ClientAuthorizationArgs
        {
            PolicyEnforcementMode = "ENFORCING",
        },
    });

    var alice = new Keycloak.User("alice", new()
    {
        RealmId = realm.Id,
        Username = "alice",
        Enabled = true,
        Email = "alice@example.com",
        FirstName = "Alice",
        LastName = "Smith",
    });

    var bob = new Keycloak.User("bob", new()
    {
        RealmId = realm.Id,
        Username = "bob",
        Enabled = true,
        Email = "bob@example.com",
        FirstName = "Bob",
        LastName = "Jones",
    });

    var testClientUserPolicy = new Keycloak.OpenId.ClientUserPolicy("test", new()
    {
        ResourceServerId = test.ResourceServerId,
        RealmId = realm.Id,
        Name = "user_policy",
        DecisionStrategy = "UNANIMOUS",
        Logic = "POSITIVE",
        Users = new[]
        {
            alice.Id,
            bob.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.Client;
import com.pulumi.keycloak.openid.ClientArgs;
import com.pulumi.keycloak.openid.inputs.ClientAuthorizationArgs;
import com.pulumi.keycloak.User;
import com.pulumi.keycloak.UserArgs;
import com.pulumi.keycloak.openid.ClientUserPolicy;
import com.pulumi.keycloak.openid.ClientUserPolicyArgs;
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 test = new Client("test", ClientArgs.builder()
            .clientId("client_id")
            .realmId(realm.id())
            .accessType("CONFIDENTIAL")
            .serviceAccountsEnabled(true)
            .authorization(ClientAuthorizationArgs.builder()
                .policyEnforcementMode("ENFORCING")
                .build())
            .build());

        var alice = new User("alice", UserArgs.builder()
            .realmId(realm.id())
            .username("alice")
            .enabled(true)
            .email("alice@example.com")
            .firstName("Alice")
            .lastName("Smith")
            .build());

        var bob = new User("bob", UserArgs.builder()
            .realmId(realm.id())
            .username("bob")
            .enabled(true)
            .email("bob@example.com")
            .firstName("Bob")
            .lastName("Jones")
            .build());

        var testClientUserPolicy = new ClientUserPolicy("testClientUserPolicy", ClientUserPolicyArgs.builder()
            .resourceServerId(test.resourceServerId())
            .realmId(realm.id())
            .name("user_policy")
            .decisionStrategy("UNANIMOUS")
            .logic("POSITIVE")
            .users(            
                alice.id(),
                bob.id())
            .build());

    }
}

    resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  test:
    type: keycloak:openid:Client
    properties:
      clientId: client_id
      realmId: ${realm.id}
      accessType: CONFIDENTIAL
      serviceAccountsEnabled: true
      authorization:
        policyEnforcementMode: ENFORCING
  alice:
    type: keycloak:User
    properties:
      realmId: ${realm.id}
      username: alice
      enabled: true
      email: alice@example.com
      firstName: Alice
      lastName: Smith
  bob:
    type: keycloak:User
    properties:
      realmId: ${realm.id}
      username: bob
      enabled: true
      email: bob@example.com
      firstName: Bob
      lastName: Jones
  testClientUserPolicy:
    type: keycloak:openid:ClientUserPolicy
    name: test
    properties:
      resourceServerId: ${test.resourceServerId}
      realmId: ${realm.id}
      name: user_policy
      decisionStrategy: UNANIMOUS
      logic: POSITIVE
      users:
        - ${alice.id}
        - ${bob.id}

    Argument Reference

    The following arguments are supported:

    • realm_id - (Required) The realm this policy exists in.
    • resource_server_id - (Required) The ID of the resource server.
    • name - (Required) The name of the policy.
    • decision_strategy - (Required) The decision strategy, can be one of UNANIMOUS, AFFIRMATIVE, or CONSENSUS.
    • users - (Required) A list of user IDs that this policy applies to.
    • logic - (Optional) The logic, can be one of POSITIVE or NEGATIVE. Defaults to POSITIVE.
    • description - (Optional) A description for the authorization policy.

    Attributes Reference

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

    • id - Policy ID representing the user policy.

    Create ClientUserPolicy Resource

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

    Constructor syntax

    new ClientUserPolicy(name: string, args: ClientUserPolicyArgs, opts?: CustomResourceOptions);
    @overload
def ClientUserPolicy(resource_name: str,
                     args: ClientUserPolicyArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ClientUserPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     decision_strategy: Optional[str] = None,
                     realm_id: Optional[str] = None,
                     resource_server_id: Optional[str] = None,
                     users: Optional[Sequence[str]] = None,
                     description: Optional[str] = None,
                     logic: Optional[str] = None,
                     name: Optional[str] = None)
    func NewClientUserPolicy(ctx *Context, name string, args ClientUserPolicyArgs, opts ...ResourceOption) (*ClientUserPolicy, error)
    public ClientUserPolicy(string name, ClientUserPolicyArgs args, CustomResourceOptions? opts = null)
    public ClientUserPolicy(String name, ClientUserPolicyArgs args)
public ClientUserPolicy(String name, ClientUserPolicyArgs args, CustomResourceOptions options)

    type: keycloak:openid:ClientUserPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClientUserPolicyArgs
    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 ClientUserPolicyArgs
    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 ClientUserPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientUserPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientUserPolicyArgs
    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 clientUserPolicyResource = new Keycloak.OpenId.ClientUserPolicy("clientUserPolicyResource", new()
{
    DecisionStrategy = "string",
    RealmId = "string",
    ResourceServerId = "string",
    Users = new[]
    {
        "string",
    },
    Description = "string",
    Logic = "string",
    Name = "string",
});

    example, err := openid.NewClientUserPolicy(ctx, "clientUserPolicyResource", &openid.ClientUserPolicyArgs{
	DecisionStrategy: pulumi.String("string"),
	RealmId:          pulumi.String("string"),
	ResourceServerId: pulumi.String("string"),
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Logic:       pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var clientUserPolicyResource = new ClientUserPolicy("clientUserPolicyResource", ClientUserPolicyArgs.builder()
    .decisionStrategy("string")
    .realmId("string")
    .resourceServerId("string")
    .users("string")
    .description("string")
    .logic("string")
    .name("string")
    .build());

    client_user_policy_resource = keycloak.openid.ClientUserPolicy("clientUserPolicyResource",
    decision_strategy="string",
    realm_id="string",
    resource_server_id="string",
    users=["string"],
    description="string",
    logic="string",
    name="string")

    const clientUserPolicyResource = new keycloak.openid.ClientUserPolicy("clientUserPolicyResource", {
    decisionStrategy: "string",
    realmId: "string",
    resourceServerId: "string",
    users: ["string"],
    description: "string",
    logic: "string",
    name: "string",
});

    type: keycloak:openid:ClientUserPolicy
properties:
    decisionStrategy: string
    description: string
    logic: string
    name: string
    realmId: string
    resourceServerId: string
    users:
        - string

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

    DecisionStrategy string
    RealmId string
    ResourceServerId string
    Users List<string>
    Description string
    Logic string
    Name string
    DecisionStrategy string
    RealmId string
    ResourceServerId string
    Users []string
    Description string
    Logic string
    Name string
    decisionStrategy String
    realmId String
    resourceServerId String
    users List<String>
    description String
    logic String
    name String
    decisionStrategy string
    realmId string
    resourceServerId string
    users string[]
    description string
    logic string
    name string
    decisionStrategy String
    realmId String
    resourceServerId String
    users List<String>
    description String
    logic String
    name String

    Outputs

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

    Get an existing ClientUserPolicy 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?: ClientUserPolicyState, opts?: CustomResourceOptions): ClientUserPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        decision_strategy: Optional[str] = None,
        description: Optional[str] = None,
        logic: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None,
        resource_server_id: Optional[str] = None,
        users: Optional[Sequence[str]] = None) -> ClientUserPolicy
    func GetClientUserPolicy(ctx *Context, name string, id IDInput, state *ClientUserPolicyState, opts ...ResourceOption) (*ClientUserPolicy, error)
    public static ClientUserPolicy Get(string name, Input<string> id, ClientUserPolicyState? state, CustomResourceOptions? opts = null)
    public static ClientUserPolicy get(String name, Output<String> id, ClientUserPolicyState state, CustomResourceOptions options)
    resources:  _:    type: keycloak:openid:ClientUserPolicy    get:      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:
    DecisionStrategy string
    Description string
    Logic string
    Name string
    RealmId string
    ResourceServerId string
    Users List<string>
    DecisionStrategy string
    Description string
    Logic string
    Name string
    RealmId string
    ResourceServerId string
    Users []string
    decisionStrategy String
    description String
    logic String
    name String
    realmId String
    resourceServerId String
    users List<String>
    decisionStrategy string
    description string
    logic string
    name string
    realmId string
    resourceServerId string
    users string[]
    decisionStrategy String
    description String
    logic String
    name String
    realmId String
    resourceServerId String
    users List<String>

    Import

    User policies can be imported using the format: {{realmId}}/{{resourceServerId}}/{{policyId}}.

    Example:

    $ terraform import keycloak_openid_client_user_policy.test my-realm/3bd4a686-1062-4b59-97b8-e4e3f10b99da/63b3cde8-987d-4cd9-9306-1955579281d9

    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 v6.10.0 published on Saturday, Feb 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-keycloak
      Meet Neo: Your AI Platform Teammate