Docs Packages
  1. Packages
  2. Keycloak
  3. API Docs
  4. openid
  5. ClientRolePolicy
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

keycloak.openid.ClientRolePolicy

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

    Create ClientRolePolicy Resource

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

    Constructor syntax

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

@overload
def ClientRolePolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     realm_id: Optional[str] = None,
                     resource_server_id: Optional[str] = None,
                     roles: Optional[Sequence[ClientRolePolicyRoleArgs]] = None,
                     type: Optional[str] = None,
                     decision_strategy: Optional[str] = None,
                     description: Optional[str] = None,
                     logic: Optional[str] = None,
                     name: Optional[str] = None)
    func NewClientRolePolicy(ctx *Context, name string, args ClientRolePolicyArgs, opts ...ResourceOption) (*ClientRolePolicy, error)
    public ClientRolePolicy(string name, ClientRolePolicyArgs args, CustomResourceOptions? opts = null)
    public ClientRolePolicy(String name, ClientRolePolicyArgs args)
public ClientRolePolicy(String name, ClientRolePolicyArgs args, CustomResourceOptions options)

    type: keycloak:openid:ClientRolePolicy
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 ClientRolePolicyArgs
    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 ClientRolePolicyArgs
    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 ClientRolePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientRolePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientRolePolicyArgs
    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 clientRolePolicyResource = new Keycloak.OpenId.ClientRolePolicy("clientRolePolicyResource", new()
{
    RealmId = "string",
    ResourceServerId = "string",
    Roles = new[]
    {
        new Keycloak.OpenId.Inputs.ClientRolePolicyRoleArgs
        {
            Id = "string",
            Required = false,
        },
    },
    Type = "string",
    DecisionStrategy = "string",
    Description = "string",
    Logic = "string",
    Name = "string",
});

    example, err := openid.NewClientRolePolicy(ctx, "clientRolePolicyResource", &openid.ClientRolePolicyArgs{
	RealmId:          pulumi.String("string"),
	ResourceServerId: pulumi.String("string"),
	Roles: openid.ClientRolePolicyRoleArray{
		&openid.ClientRolePolicyRoleArgs{
			Id:       pulumi.String("string"),
			Required: pulumi.Bool(false),
		},
	},
	Type:             pulumi.String("string"),
	DecisionStrategy: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Logic:            pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var clientRolePolicyResource = new ClientRolePolicy("clientRolePolicyResource", ClientRolePolicyArgs.builder()
    .realmId("string")
    .resourceServerId("string")
    .roles(ClientRolePolicyRoleArgs.builder()
        .id("string")
        .required(false)
        .build())
    .type("string")
    .decisionStrategy("string")
    .description("string")
    .logic("string")
    .name("string")
    .build());

    client_role_policy_resource = keycloak.openid.ClientRolePolicy("clientRolePolicyResource",
    realm_id="string",
    resource_server_id="string",
    roles=[keycloak.openid.ClientRolePolicyRoleArgs(
        id="string",
        required=False,
    )],
    type="string",
    decision_strategy="string",
    description="string",
    logic="string",
    name="string")

    const clientRolePolicyResource = new keycloak.openid.ClientRolePolicy("clientRolePolicyResource", {
    realmId: "string",
    resourceServerId: "string",
    roles: [{
        id: "string",
        required: false,
    }],
    type: "string",
    decisionStrategy: "string",
    description: "string",
    logic: "string",
    name: "string",
});

    type: keycloak:openid:ClientRolePolicy
properties:
    decisionStrategy: string
    description: string
    logic: string
    name: string
    realmId: string
    resourceServerId: string
    roles:
        - id: string
          required: false
    type: string

    ClientRolePolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ClientRolePolicy resource accepts the following input properties:

    Outputs

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

    Get an existing ClientRolePolicy 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?: ClientRolePolicyState, opts?: CustomResourceOptions): ClientRolePolicy
    @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,
        roles: Optional[Sequence[ClientRolePolicyRoleArgs]] = None,
        type: Optional[str] = None) -> ClientRolePolicy
    func GetClientRolePolicy(ctx *Context, name string, id IDInput, state *ClientRolePolicyState, opts ...ResourceOption) (*ClientRolePolicy, error)
    public static ClientRolePolicy Get(string name, Input<string> id, ClientRolePolicyState? state, CustomResourceOptions? opts = null)
    public static ClientRolePolicy get(String name, Output<String> id, ClientRolePolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:

    Supporting Types

    ClientRolePolicyRole, ClientRolePolicyRoleArgs

    Id string
    Required bool
    Id string
    Required bool
    id String
    required Boolean
    id string
    required boolean
    id str
    required bool
    id String
    required Boolean

    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 v5.3.2 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-keycloak