Docs Home
Keycloak v6.3.0 published on Tuesday, Apr 15, 2025 by Pulumi
keycloak.openid.ClientUserPolicy
Explore with Pulumi AI
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
This property is required. string - The unique name of the resource.
- args
This property is required. ClientUserPolicyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ClientUserPolicyArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ClientUserPolicyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Decision
Strategy This property is required. string - Realm
Id This property is required. string - Resource
Server Id This property is required. string - Users
This property is required. List<string> - Description string
- Logic string
- Name string
- Decision
Strategy This property is required. string - Realm
Id This property is required. string - Resource
Server Id This property is required. string - Users
This property is required. []string - Description string
- Logic string
- Name string
- decision
Strategy This property is required. String - realm
Id This property is required. String - resource
Server Id This property is required. String - users
This property is required. List<String> - description String
- logic String
- name String
- decision
Strategy This property is required. string - realm
Id This property is required. string - resource
Server Id This property is required. string - users
This property is required. string[] - description string
- logic string
- name string
- decision_
strategy This property is required. str - realm_
id This property is required. str - resource_
server_ id This property is required. str - users
This property is required. Sequence[str] - description str
- logic str
- name str
- decision
Strategy This property is required. String - realm
Id This property is required. String - resource
Server Id This property is required. String - users
This property is required. 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) -> ClientUserPolicyfunc 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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:
- Decision
Strategy string - Description string
- Logic string
- Name string
- Realm
Id string - Resource
Server stringId - Users List<string>
- Decision
Strategy string - Description string
- Logic string
- Name string
- Realm
Id string - Resource
Server stringId - Users []string
- decision
Strategy String - description String
- logic String
- name String
- realm
Id String - resource
Server StringId - users List<String>
- decision
Strategy string - description string
- logic string
- name string
- realm
Id string - resource
Server stringId - users string[]
- decision_
strategy str - description str
- logic str
- name str
- realm_
id str - resource_
server_ strid - users Sequence[str]
- decision
Strategy String - description String
- logic String
- name String
- realm
Id String - resource
Server StringId - users List<String>
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.