Docs Home
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
keycloak.openid.ClientAuthorizationResource
Explore with Pulumi AI
Create ClientAuthorizationResource Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientAuthorizationResource(name: string, args: ClientAuthorizationResourceArgs, opts?: CustomResourceOptions);@overload
def ClientAuthorizationResource(resource_name: str,
args: ClientAuthorizationResourceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientAuthorizationResource(resource_name: str,
opts: Optional[ResourceOptions] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
attributes: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
icon_uri: Optional[str] = None,
name: Optional[str] = None,
owner_managed_access: Optional[bool] = None,
scopes: Optional[Sequence[str]] = None,
type: Optional[str] = None,
uris: Optional[Sequence[str]] = None)func NewClientAuthorizationResource(ctx *Context, name string, args ClientAuthorizationResourceArgs, opts ...ResourceOption) (*ClientAuthorizationResource, error)public ClientAuthorizationResource(string name, ClientAuthorizationResourceArgs args, CustomResourceOptions? opts = null)public ClientAuthorizationResource(String name, ClientAuthorizationResourceArgs args)
public ClientAuthorizationResource(String name, ClientAuthorizationResourceArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientAuthorizationResource
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. ClientAuthorizationResourceArgs - 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. ClientAuthorizationResourceArgs - 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. ClientAuthorizationResourceArgs - 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. ClientAuthorizationResourceArgs - 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. ClientAuthorizationResourceArgs - 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 clientAuthorizationResourceResource = new Keycloak.OpenId.ClientAuthorizationResource("clientAuthorizationResourceResource", new()
{
RealmId = "string",
ResourceServerId = "string",
Attributes =
{
{ "string", "string" },
},
DisplayName = "string",
IconUri = "string",
Name = "string",
OwnerManagedAccess = false,
Scopes = new[]
{
"string",
},
Type = "string",
Uris = new[]
{
"string",
},
});
example, err := openid.NewClientAuthorizationResource(ctx, "clientAuthorizationResourceResource", &openid.ClientAuthorizationResourceArgs{
RealmId: pulumi.String("string"),
ResourceServerId: pulumi.String("string"),
Attributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
IconUri: pulumi.String("string"),
Name: pulumi.String("string"),
OwnerManagedAccess: pulumi.Bool(false),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
Uris: pulumi.StringArray{
pulumi.String("string"),
},
})
var clientAuthorizationResourceResource = new ClientAuthorizationResource("clientAuthorizationResourceResource", ClientAuthorizationResourceArgs.builder()
.realmId("string")
.resourceServerId("string")
.attributes(Map.of("string", "string"))
.displayName("string")
.iconUri("string")
.name("string")
.ownerManagedAccess(false)
.scopes("string")
.type("string")
.uris("string")
.build());
client_authorization_resource_resource = keycloak.openid.ClientAuthorizationResource("clientAuthorizationResourceResource",
realm_id="string",
resource_server_id="string",
attributes={
"string": "string",
},
display_name="string",
icon_uri="string",
name="string",
owner_managed_access=False,
scopes=["string"],
type="string",
uris=["string"])
const clientAuthorizationResourceResource = new keycloak.openid.ClientAuthorizationResource("clientAuthorizationResourceResource", {
realmId: "string",
resourceServerId: "string",
attributes: {
string: "string",
},
displayName: "string",
iconUri: "string",
name: "string",
ownerManagedAccess: false,
scopes: ["string"],
type: "string",
uris: ["string"],
});
type: keycloak:openid:ClientAuthorizationResource
properties:
attributes:
string: string
displayName: string
iconUri: string
name: string
ownerManagedAccess: false
realmId: string
resourceServerId: string
scopes:
- string
type: string
uris:
- string
ClientAuthorizationResource 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 ClientAuthorizationResource resource accepts the following input properties:
- Realm
Id stringThis property is required. 
Changes to this property will trigger replacement. - Resource
Server Id stringThis property is required. Changes to this property will trigger replacement. - Attributes Dictionary<string, string>
- Display
Name string - Icon
Uri string - Name string
- Owner
Managed boolAccess - Scopes List<string>
- Type string
- Uris List<string>
- Realm
Id stringThis property is required. Changes to this property will trigger replacement. - Resource
Server Id stringThis property is required. Changes to this property will trigger replacement. - Attributes map[string]string
- Display
Name string - Icon
Uri string - Name string
- Owner
Managed boolAccess - Scopes []string
- Type string
- Uris []string
- realm
Id StringThis property is required. Changes to this property will trigger replacement. - resource
Server Id StringThis property is required. Changes to this property will trigger replacement. - attributes Map<String,String>
- display
Name String - icon
Uri String - name String
- owner
Managed BooleanAccess - scopes List<String>
- type String
- uris List<String>
- realm
Id stringThis property is required. Changes to this property will trigger replacement. - resource
Server Id stringThis property is required. Changes to this property will trigger replacement. - attributes {[key: string]: string}
- display
Name string - icon
Uri string - name string
- owner
Managed booleanAccess - scopes string[]
- type string
- uris string[]
- realm_
id strThis property is required. Changes to this property will trigger replacement. - resource_
server_ id strThis property is required. Changes to this property will trigger replacement. - attributes Mapping[str, str]
- display_
name str - icon_
uri str - name str
- owner_
managed_ boolaccess - scopes Sequence[str]
- type str
- uris Sequence[str]
- realm
Id StringThis property is required. Changes to this property will trigger replacement. - resource
Server Id StringThis property is required. Changes to this property will trigger replacement. - attributes Map<String>
- display
Name String - icon
Uri String - name String
- owner
Managed BooleanAccess - scopes List<String>
- type String
- uris List<String>
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientAuthorizationResource 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 ClientAuthorizationResource Resource
Get an existing ClientAuthorizationResource 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?: ClientAuthorizationResourceState, opts?: CustomResourceOptions): ClientAuthorizationResource@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attributes: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
icon_uri: Optional[str] = None,
name: Optional[str] = None,
owner_managed_access: Optional[bool] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
type: Optional[str] = None,
uris: Optional[Sequence[str]] = None) -> ClientAuthorizationResourcefunc GetClientAuthorizationResource(ctx *Context, name string, id IDInput, state *ClientAuthorizationResourceState, opts ...ResourceOption) (*ClientAuthorizationResource, error)public static ClientAuthorizationResource Get(string name, Input<string> id, ClientAuthorizationResourceState? state, CustomResourceOptions? opts = null)public static ClientAuthorizationResource get(String name, Output<String> id, ClientAuthorizationResourceState state, CustomResourceOptions options)resources: _: type: keycloak:openid:ClientAuthorizationResource 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:
- Attributes Dictionary<string, string>
- Display
Name string - Icon
Uri string - Name string
- Owner
Managed boolAccess - Realm
Id - Resource
Server Id - Scopes List<string>
- Type string
- Uris List<string>
- Attributes map[string]string
- Display
Name string - Icon
Uri string - Name string
- Owner
Managed boolAccess - Realm
Id - Resource
Server Id - Scopes []string
- Type string
- Uris []string
- attributes Map<String,String>
- display
Name String - icon
Uri String - name String
- owner
Managed BooleanAccess - realm
Id - resource
Server Id - scopes List<String>
- type String
- uris List<String>
- attributes {[key: string]: string}
- display
Name string - icon
Uri string - name string
- owner
Managed booleanAccess - realm
Id - resource
Server Id - scopes string[]
- type string
- uris string[]
- attributes Mapping[str, str]
- display_
name str - icon_
uri str - name str
- owner_
managed_ boolaccess - realm_
id - resource_
server_ id - scopes Sequence[str]
- type str
- uris Sequence[str]
- attributes Map<String>
- display
Name String - icon
Uri String - name String
- owner
Managed BooleanAccess - realm
Id - resource
Server Id - scopes List<String>
- type String
- uris List<String>
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.