keycloak.openid.ClientGroupPolicy
Explore with Pulumi AI
Create ClientGroupPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientGroupPolicy(name: string, args: ClientGroupPolicyArgs, opts?: CustomResourceOptions);
@overload
def ClientGroupPolicy(resource_name: str,
args: ClientGroupPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientGroupPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
decision_strategy: Optional[str] = None,
groups: Optional[Sequence[ClientGroupPolicyGroupArgs]] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
description: Optional[str] = None,
groups_claim: Optional[str] = None,
logic: Optional[str] = None,
name: Optional[str] = None)
func NewClientGroupPolicy(ctx *Context, name string, args ClientGroupPolicyArgs, opts ...ResourceOption) (*ClientGroupPolicy, error)
public ClientGroupPolicy(string name, ClientGroupPolicyArgs args, CustomResourceOptions? opts = null)
public ClientGroupPolicy(String name, ClientGroupPolicyArgs args)
public ClientGroupPolicy(String name, ClientGroupPolicyArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientGroupPolicy
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. ClientGroupPolicyArgs - 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. ClientGroupPolicyArgs - 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. ClientGroupPolicyArgs - 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. ClientGroupPolicyArgs - 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. ClientGroupPolicyArgs - 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 clientGroupPolicyResource = new Keycloak.OpenId.ClientGroupPolicy("clientGroupPolicyResource", new()
{
DecisionStrategy = "string",
Groups = new[]
{
new Keycloak.OpenId.Inputs.ClientGroupPolicyGroupArgs
{
ExtendChildren = false,
Id = "string",
Path = "string",
},
},
RealmId = "string",
ResourceServerId = "string",
Description = "string",
GroupsClaim = "string",
Logic = "string",
Name = "string",
});
example, err := openid.NewClientGroupPolicy(ctx, "clientGroupPolicyResource", &openid.ClientGroupPolicyArgs{
DecisionStrategy: pulumi.String("string"),
Groups: openid.ClientGroupPolicyGroupArray{
&openid.ClientGroupPolicyGroupArgs{
ExtendChildren: pulumi.Bool(false),
Id: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
RealmId: pulumi.String("string"),
ResourceServerId: pulumi.String("string"),
Description: pulumi.String("string"),
GroupsClaim: pulumi.String("string"),
Logic: pulumi.String("string"),
Name: pulumi.String("string"),
})
var clientGroupPolicyResource = new ClientGroupPolicy("clientGroupPolicyResource", ClientGroupPolicyArgs.builder()
.decisionStrategy("string")
.groups(ClientGroupPolicyGroupArgs.builder()
.extendChildren(false)
.id("string")
.path("string")
.build())
.realmId("string")
.resourceServerId("string")
.description("string")
.groupsClaim("string")
.logic("string")
.name("string")
.build());
client_group_policy_resource = keycloak.openid.ClientGroupPolicy("clientGroupPolicyResource",
decision_strategy="string",
groups=[{
"extend_children": False,
"id": "string",
"path": "string",
}],
realm_id="string",
resource_server_id="string",
description="string",
groups_claim="string",
logic="string",
name="string")
const clientGroupPolicyResource = new keycloak.openid.ClientGroupPolicy("clientGroupPolicyResource", {
decisionStrategy: "string",
groups: [{
extendChildren: false,
id: "string",
path: "string",
}],
realmId: "string",
resourceServerId: "string",
description: "string",
groupsClaim: "string",
logic: "string",
name: "string",
});
type: keycloak:openid:ClientGroupPolicy
properties:
decisionStrategy: string
description: string
groups:
- extendChildren: false
id: string
path: string
groupsClaim: string
logic: string
name: string
realmId: string
resourceServerId: string
ClientGroupPolicy 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 ClientGroupPolicy resource accepts the following input properties:
- Decision
Strategy This property is required. string - Groups
This property is required. List<ClientGroup Policy Group> - Realm
Id This property is required. string - Resource
Server Id This property is required. string - Description string
- Groups
Claim string - Logic string
- Name string
- Decision
Strategy This property is required. string - Groups
This property is required. []ClientGroup Policy Group Args - Realm
Id This property is required. string - Resource
Server Id This property is required. string - Description string
- Groups
Claim string - Logic string
- Name string
- decision
Strategy This property is required. String - groups
This property is required. List<ClientGroup Policy Group> - realm
Id This property is required. String - resource
Server Id This property is required. String - description String
- groups
Claim String - logic String
- name String
- decision
Strategy This property is required. string - groups
This property is required. ClientGroup Policy Group[] - realm
Id This property is required. string - resource
Server Id This property is required. string - description string
- groups
Claim string - logic string
- name string
- decision_
strategy This property is required. str - groups
This property is required. Sequence[ClientGroup Policy Group Args] - realm_
id This property is required. str - resource_
server_ id This property is required. str - description str
- groups_
claim str - logic str
- name str
- decision
Strategy This property is required. String - groups
This property is required. List<Property Map> - realm
Id This property is required. String - resource
Server Id This property is required. String - description String
- groups
Claim String - logic String
- name String
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientGroupPolicy 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 ClientGroupPolicy Resource
Get an existing ClientGroupPolicy 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?: ClientGroupPolicyState, opts?: CustomResourceOptions): ClientGroupPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
decision_strategy: Optional[str] = None,
description: Optional[str] = None,
groups: Optional[Sequence[ClientGroupPolicyGroupArgs]] = None,
groups_claim: Optional[str] = None,
logic: Optional[str] = None,
name: Optional[str] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None) -> ClientGroupPolicy
func GetClientGroupPolicy(ctx *Context, name string, id IDInput, state *ClientGroupPolicyState, opts ...ResourceOption) (*ClientGroupPolicy, error)
public static ClientGroupPolicy Get(string name, Input<string> id, ClientGroupPolicyState? state, CustomResourceOptions? opts = null)
public static ClientGroupPolicy get(String name, Output<String> id, ClientGroupPolicyState state, CustomResourceOptions options)
resources: _: type: keycloak:openid:ClientGroupPolicy 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.
- Decision
Strategy string - Description string
- Groups
List<Client
Group Policy Group> - Groups
Claim string - Logic string
- Name string
- Realm
Id string - Resource
Server stringId
- Decision
Strategy string - Description string
- Groups
[]Client
Group Policy Group Args - Groups
Claim string - Logic string
- Name string
- Realm
Id string - Resource
Server stringId
- decision
Strategy String - description String
- groups
List<Client
Group Policy Group> - groups
Claim String - logic String
- name String
- realm
Id String - resource
Server StringId
- decision
Strategy string - description string
- groups
Client
Group Policy Group[] - groups
Claim string - logic string
- name string
- realm
Id string - resource
Server stringId
- decision
Strategy String - description String
- groups List<Property Map>
- groups
Claim String - logic String
- name String
- realm
Id String - resource
Server StringId
Supporting Types
ClientGroupPolicyGroup, ClientGroupPolicyGroupArgs
- Extend
Children This property is required. bool - Id
This property is required. string - Path
This property is required. string
- Extend
Children This property is required. bool - Id
This property is required. string - Path
This property is required. string
- extend
Children This property is required. Boolean - id
This property is required. String - path
This property is required. String
- extend
Children This property is required. boolean - id
This property is required. string - path
This property is required. string
- extend_
children This property is required. bool - id
This property is required. str - path
This property is required. str
- extend
Children This property is required. Boolean - id
This property is required. String - path
This property is required. String
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloak
Terraform Provider.