keycloak.openid.ClientPolicy

Keycloak v6.10.0, Feb 21 26

Viewing docs for Keycloak v6.10.0
published on Saturday, Feb 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-keycloak

Viewing docs for Keycloak v6.10.0
published on Saturday, Feb 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-keycloak

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 client1 = new keycloak.openid.Client("client1", {
    clientId: "client1",
    realmId: realm.id,
    accessType: "CONFIDENTIAL",
    serviceAccountsEnabled: true,
});
const client2 = new keycloak.openid.Client("client2", {
    clientId: "client2",
    realmId: realm.id,
    accessType: "CONFIDENTIAL",
    serviceAccountsEnabled: true,
});
const testClientPolicy = new keycloak.openid.ClientPolicy("test", {
    resourceServerId: test.resourceServerId,
    realmId: realm.id,
    name: "client_policy",
    decisionStrategy: "UNANIMOUS",
    logic: "POSITIVE",
    clients: [
        client1.id,
        client2.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",
    })
client1 = keycloak.openid.Client("client1",
    client_id="client1",
    realm_id=realm.id,
    access_type="CONFIDENTIAL",
    service_accounts_enabled=True)
client2 = keycloak.openid.Client("client2",
    client_id="client2",
    realm_id=realm.id,
    access_type="CONFIDENTIAL",
    service_accounts_enabled=True)
test_client_policy = keycloak.openid.ClientPolicy("test",
    resource_server_id=test.resource_server_id,
    realm_id=realm.id,
    name="client_policy",
    decision_strategy="UNANIMOUS",
    logic="POSITIVE",
    clients=[
        client1.id,
        client2.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
		}
		client1, err := openid.NewClient(ctx, "client1", &openid.ClientArgs{
			ClientId:               pulumi.String("client1"),
			RealmId:                realm.ID(),
			AccessType:             pulumi.String("CONFIDENTIAL"),
			ServiceAccountsEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		client2, err := openid.NewClient(ctx, "client2", &openid.ClientArgs{
			ClientId:               pulumi.String("client2"),
			RealmId:                realm.ID(),
			AccessType:             pulumi.String("CONFIDENTIAL"),
			ServiceAccountsEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewClientPolicy(ctx, "test", &openid.ClientPolicyArgs{
			ResourceServerId: test.ResourceServerId,
			RealmId:          realm.ID(),
			Name:             pulumi.String("client_policy"),
			DecisionStrategy: pulumi.String("UNANIMOUS"),
			Logic:            pulumi.String("POSITIVE"),
			Clients: pulumi.StringArray{
				client1.ID(),
				client2.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 client1 = new Keycloak.OpenId.Client("client1", new()
    {
        ClientId = "client1",
        RealmId = realm.Id,
        AccessType = "CONFIDENTIAL",
        ServiceAccountsEnabled = true,
    });

    var client2 = new Keycloak.OpenId.Client("client2", new()
    {
        ClientId = "client2",
        RealmId = realm.Id,
        AccessType = "CONFIDENTIAL",
        ServiceAccountsEnabled = true,
    });

    var testClientPolicy = new Keycloak.OpenId.ClientPolicy("test", new()
    {
        ResourceServerId = test.ResourceServerId,
        RealmId = realm.Id,
        Name = "client_policy",
        DecisionStrategy = "UNANIMOUS",
        Logic = "POSITIVE",
        Clients = new[]
        {
            client1.Id,
            client2.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.openid.ClientPolicy;
import com.pulumi.keycloak.openid.ClientPolicyArgs;
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 client1 = new Client("client1", ClientArgs.builder()
            .clientId("client1")
            .realmId(realm.id())
            .accessType("CONFIDENTIAL")
            .serviceAccountsEnabled(true)
            .build());

        var client2 = new Client("client2", ClientArgs.builder()
            .clientId("client2")
            .realmId(realm.id())
            .accessType("CONFIDENTIAL")
            .serviceAccountsEnabled(true)
            .build());

        var testClientPolicy = new ClientPolicy("testClientPolicy", ClientPolicyArgs.builder()
            .resourceServerId(test.resourceServerId())
            .realmId(realm.id())
            .name("client_policy")
            .decisionStrategy("UNANIMOUS")
            .logic("POSITIVE")
            .clients(            
                client1.id(),
                client2.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
  client1:
    type: keycloak:openid:Client
    properties:
      clientId: client1
      realmId: ${realm.id}
      accessType: CONFIDENTIAL
      serviceAccountsEnabled: true
  client2:
    type: keycloak:openid:Client
    properties:
      clientId: client2
      realmId: ${realm.id}
      accessType: CONFIDENTIAL
      serviceAccountsEnabled: true
  testClientPolicy:
    type: keycloak:openid:ClientPolicy
    name: test
    properties:
      resourceServerId: ${test.resourceServerId}
      realmId: ${realm.id}
      name: client_policy
      decisionStrategy: UNANIMOUS
      logic: POSITIVE
      clients:
        - ${client1.id}
        - ${client2.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.
clients - (Required) A list of client IDs that this policy applies to.
decision_strategy - (Optional) The decision strategy, can be one of UNANIMOUS, AFFIRMATIVE, or CONSENSUS.
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 client policy.

Create ClientPolicy Resource

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

Constructor syntax

new ClientPolicy(name: string, args: ClientPolicyArgs, opts?: CustomResourceOptions);

@overload
def ClientPolicy(resource_name: str,
                 args: ClientPolicyArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ClientPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 clients: Optional[Sequence[str]] = None,
                 realm_id: Optional[str] = None,
                 resource_server_id: Optional[str] = None,
                 decision_strategy: Optional[str] = None,
                 description: Optional[str] = None,
                 logic: Optional[str] = None,
                 name: Optional[str] = None)

func NewClientPolicy(ctx *Context, name string, args ClientPolicyArgs, opts ...ResourceOption) (*ClientPolicy, error)

public ClientPolicy(string name, ClientPolicyArgs args, CustomResourceOptions? opts = null)

public ClientPolicy(String name, ClientPolicyArgs args)
public ClientPolicy(String name, ClientPolicyArgs args, CustomResourceOptions options)

type: keycloak:openid:ClientPolicy
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 ClientPolicyArgs: 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 ClientPolicyArgs: 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 ClientPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClientPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClientPolicyArgs: 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 clientPolicyResource = new Keycloak.OpenId.ClientPolicy("clientPolicyResource", new()
{
    Clients = new[]
    {
        "string",
    },
    RealmId = "string",
    ResourceServerId = "string",
    DecisionStrategy = "string",
    Description = "string",
    Logic = "string",
    Name = "string",
});

example, err := openid.NewClientPolicy(ctx, "clientPolicyResource", &openid.ClientPolicyArgs{
	Clients: pulumi.StringArray{
		pulumi.String("string"),
	},
	RealmId:          pulumi.String("string"),
	ResourceServerId: pulumi.String("string"),
	DecisionStrategy: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Logic:            pulumi.String("string"),
	Name:             pulumi.String("string"),
})

var clientPolicyResource = new ClientPolicy("clientPolicyResource", ClientPolicyArgs.builder()
    .clients("string")
    .realmId("string")
    .resourceServerId("string")
    .decisionStrategy("string")
    .description("string")
    .logic("string")
    .name("string")
    .build());

client_policy_resource = keycloak.openid.ClientPolicy("clientPolicyResource",
    clients=["string"],
    realm_id="string",
    resource_server_id="string",
    decision_strategy="string",
    description="string",
    logic="string",
    name="string")

const clientPolicyResource = new keycloak.openid.ClientPolicy("clientPolicyResource", {
    clients: ["string"],
    realmId: "string",
    resourceServerId: "string",
    decisionStrategy: "string",
    description: "string",
    logic: "string",
    name: "string",
});

type: keycloak:openid:ClientPolicy
properties:
    clients:
        - string
    decisionStrategy: string
    description: string
    logic: string
    name: string
    realmId: string
    resourceServerId: string

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

Clients List<string>
RealmId string
ResourceServerId string
DecisionStrategy string
Description string
Logic string
Name string

Clients []string
RealmId string
ResourceServerId string
DecisionStrategy string
Description string
Logic string
Name string

clients List<String>
realmId String
resourceServerId String
decisionStrategy String
description String
logic String
name String

clients string[]
realmId string
resourceServerId string
decisionStrategy string
description string
logic string
name string

clients Sequence[str]
realm_id str
resource_server_id str
decision_strategy str
description str
logic str
name str

clients List<String>
realmId String
resourceServerId String
decisionStrategy String
description String
logic String
name String

Outputs

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

Get an existing ClientPolicy 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?: ClientPolicyState, opts?: CustomResourceOptions): ClientPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clients: Optional[Sequence[str]] = 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) -> ClientPolicy

func GetClientPolicy(ctx *Context, name string, id IDInput, state *ClientPolicyState, opts ...ResourceOption) (*ClientPolicy, error)

public static ClientPolicy Get(string name, Input<string> id, ClientPolicyState? state, CustomResourceOptions? opts = null)

public static ClientPolicy get(String name, Output<String> id, ClientPolicyState state, CustomResourceOptions options)

resources:  _:    type: keycloak:openid:ClientPolicy    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:

Clients List<string>
DecisionStrategy string
Description string
Logic string
Name string
RealmId string
ResourceServerId string

Clients []string
DecisionStrategy string
Description string
Logic string
Name string
RealmId string
ResourceServerId string

clients List<String>
decisionStrategy String
description String
logic String
name String
realmId String
resourceServerId String

clients string[]
decisionStrategy string
description string
logic string
name string
realmId string
resourceServerId string

clients Sequence[str]
decision_strategy str
description str
logic str
name str
realm_id str
resource_server_id str

clients List<String>
decisionStrategy String
description String
logic String
name String
realmId String
resourceServerId String

Import

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

Example:

$ terraform import keycloak_openid_client_client_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.

Viewing docs for Keycloak v6.10.0
published on Saturday, Feb 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-keycloak

keycloak.openid.ClientPolicy

On this page

On this page

Example Usage

Argument Reference

Attributes Reference

Create ClientPolicy Resource

Constructor syntax

Parameters

Constructor example

ClientPolicy Resource Properties

Inputs

Outputs

Look up Existing ClientPolicy Resource

Import

Package Details

On this page

On this page