1. Packages
  2. Keycloak
  3. API Docs
  4. openid
  5. ClientAuthorizationPermission
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi

keycloak.openid.ClientAuthorizationPermission

Explore with Pulumi AI

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

    Allows you to manage openid Client Authorization Permissions.

    Create ClientAuthorizationPermission Resource

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

    Constructor syntax

    new ClientAuthorizationPermission(name: string, args: ClientAuthorizationPermissionArgs, opts?: CustomResourceOptions);
    @overload
    def ClientAuthorizationPermission(resource_name: str,
                                      args: ClientAuthorizationPermissionArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClientAuthorizationPermission(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      realm_id: Optional[str] = None,
                                      resource_server_id: Optional[str] = None,
                                      decision_strategy: Optional[str] = None,
                                      description: Optional[str] = None,
                                      name: Optional[str] = None,
                                      policies: Optional[Sequence[str]] = None,
                                      resource_type: Optional[str] = None,
                                      resources: Optional[Sequence[str]] = None,
                                      scopes: Optional[Sequence[str]] = None,
                                      type: Optional[str] = None)
    func NewClientAuthorizationPermission(ctx *Context, name string, args ClientAuthorizationPermissionArgs, opts ...ResourceOption) (*ClientAuthorizationPermission, error)
    public ClientAuthorizationPermission(string name, ClientAuthorizationPermissionArgs args, CustomResourceOptions? opts = null)
    public ClientAuthorizationPermission(String name, ClientAuthorizationPermissionArgs args)
    public ClientAuthorizationPermission(String name, ClientAuthorizationPermissionArgs args, CustomResourceOptions options)
    
    type: keycloak:openid:ClientAuthorizationPermission
    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 ClientAuthorizationPermissionArgs
    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 ClientAuthorizationPermissionArgs
    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 ClientAuthorizationPermissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientAuthorizationPermissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientAuthorizationPermissionArgs
    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 clientAuthorizationPermissionResource = new Keycloak.OpenId.ClientAuthorizationPermission("clientAuthorizationPermissionResource", new()
    {
        RealmId = "string",
        ResourceServerId = "string",
        DecisionStrategy = "string",
        Description = "string",
        Name = "string",
        Policies = new[]
        {
            "string",
        },
        ResourceType = "string",
        Resources = new[]
        {
            "string",
        },
        Scopes = new[]
        {
            "string",
        },
        Type = "string",
    });
    
    example, err := openid.NewClientAuthorizationPermission(ctx, "clientAuthorizationPermissionResource", &openid.ClientAuthorizationPermissionArgs{
    	RealmId:          pulumi.String("string"),
    	ResourceServerId: pulumi.String("string"),
    	DecisionStrategy: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Policies: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ResourceType: pulumi.String("string"),
    	Resources: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Scopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var clientAuthorizationPermissionResource = new ClientAuthorizationPermission("clientAuthorizationPermissionResource", ClientAuthorizationPermissionArgs.builder()
        .realmId("string")
        .resourceServerId("string")
        .decisionStrategy("string")
        .description("string")
        .name("string")
        .policies("string")
        .resourceType("string")
        .resources("string")
        .scopes("string")
        .type("string")
        .build());
    
    client_authorization_permission_resource = keycloak.openid.ClientAuthorizationPermission("clientAuthorizationPermissionResource",
        realm_id="string",
        resource_server_id="string",
        decision_strategy="string",
        description="string",
        name="string",
        policies=["string"],
        resource_type="string",
        resources=["string"],
        scopes=["string"],
        type="string")
    
    const clientAuthorizationPermissionResource = new keycloak.openid.ClientAuthorizationPermission("clientAuthorizationPermissionResource", {
        realmId: "string",
        resourceServerId: "string",
        decisionStrategy: "string",
        description: "string",
        name: "string",
        policies: ["string"],
        resourceType: "string",
        resources: ["string"],
        scopes: ["string"],
        type: "string",
    });
    
    type: keycloak:openid:ClientAuthorizationPermission
    properties:
        decisionStrategy: string
        description: string
        name: string
        policies:
            - string
        realmId: string
        resourceServerId: string
        resourceType: string
        resources:
            - string
        scopes:
            - string
        type: string
    

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

    RealmId string
    ResourceServerId string
    DecisionStrategy string
    Description string
    Name string
    Policies List<string>
    ResourceType string
    Resources List<string>
    Scopes List<string>
    Type string
    RealmId string
    ResourceServerId string
    DecisionStrategy string
    Description string
    Name string
    Policies []string
    ResourceType string
    Resources []string
    Scopes []string
    Type string
    realmId String
    resourceServerId String
    decisionStrategy String
    description String
    name String
    policies List<String>
    resourceType String
    resources List<String>
    scopes List<String>
    type String
    realmId string
    resourceServerId string
    decisionStrategy string
    description string
    name string
    policies string[]
    resourceType string
    resources string[]
    scopes string[]
    type string
    realm_id str
    resource_server_id str
    decision_strategy str
    description str
    name str
    policies Sequence[str]
    resource_type str
    resources Sequence[str]
    scopes Sequence[str]
    type str
    realmId String
    resourceServerId String
    decisionStrategy String
    description String
    name String
    policies List<String>
    resourceType String
    resources List<String>
    scopes List<String>
    type String

    Outputs

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

    Get an existing ClientAuthorizationPermission 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?: ClientAuthorizationPermissionState, opts?: CustomResourceOptions): ClientAuthorizationPermission
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            decision_strategy: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            policies: Optional[Sequence[str]] = None,
            realm_id: Optional[str] = None,
            resource_server_id: Optional[str] = None,
            resource_type: Optional[str] = None,
            resources: Optional[Sequence[str]] = None,
            scopes: Optional[Sequence[str]] = None,
            type: Optional[str] = None) -> ClientAuthorizationPermission
    func GetClientAuthorizationPermission(ctx *Context, name string, id IDInput, state *ClientAuthorizationPermissionState, opts ...ResourceOption) (*ClientAuthorizationPermission, error)
    public static ClientAuthorizationPermission Get(string name, Input<string> id, ClientAuthorizationPermissionState? state, CustomResourceOptions? opts = null)
    public static ClientAuthorizationPermission get(String name, Output<String> id, ClientAuthorizationPermissionState 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:
    DecisionStrategy string
    Description string
    Name string
    Policies List<string>
    RealmId string
    ResourceServerId string
    ResourceType string
    Resources List<string>
    Scopes List<string>
    Type string
    DecisionStrategy string
    Description string
    Name string
    Policies []string
    RealmId string
    ResourceServerId string
    ResourceType string
    Resources []string
    Scopes []string
    Type string
    decisionStrategy String
    description String
    name String
    policies List<String>
    realmId String
    resourceServerId String
    resourceType String
    resources List<String>
    scopes List<String>
    type String
    decisionStrategy string
    description string
    name string
    policies string[]
    realmId string
    resourceServerId string
    resourceType string
    resources string[]
    scopes string[]
    type string
    decision_strategy str
    description str
    name str
    policies Sequence[str]
    realm_id str
    resource_server_id str
    resource_type str
    resources Sequence[str]
    scopes Sequence[str]
    type str
    decisionStrategy String
    description String
    name String
    policies List<String>
    realmId String
    resourceServerId String
    resourceType String
    resources List<String>
    scopes List<String>
    type String

    Import

    Client authorization permissions can be imported using the format: {{realmId}}/{{resourceServerId}}/{{permissionId}}.

    Example:

    bash

    $ pulumi import keycloak:openid/clientAuthorizationPermission:ClientAuthorizationPermission 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 v5.3.2 published on Friday, May 10, 2024 by Pulumi