Docs Home
Keycloak v6.5.0 published on Tuesday, May 13, 2025 by Pulumi
keycloak.openid.ClientAuthorizationScope
Explore with Pulumi AI
Create ClientAuthorizationScope Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientAuthorizationScope(name: string, args: ClientAuthorizationScopeArgs, opts?: CustomResourceOptions);@overload
def ClientAuthorizationScope(resource_name: str,
args: ClientAuthorizationScopeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientAuthorizationScope(resource_name: str,
opts: Optional[ResourceOptions] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
display_name: Optional[str] = None,
icon_uri: Optional[str] = None,
name: Optional[str] = None)func NewClientAuthorizationScope(ctx *Context, name string, args ClientAuthorizationScopeArgs, opts ...ResourceOption) (*ClientAuthorizationScope, error)public ClientAuthorizationScope(string name, ClientAuthorizationScopeArgs args, CustomResourceOptions? opts = null)
public ClientAuthorizationScope(String name, ClientAuthorizationScopeArgs args)
public ClientAuthorizationScope(String name, ClientAuthorizationScopeArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientAuthorizationScope
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 ClientAuthorizationScopeArgs
- 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 ClientAuthorizationScopeArgs
- 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 ClientAuthorizationScopeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientAuthorizationScopeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientAuthorizationScopeArgs
- 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 clientAuthorizationScopeResource = new Keycloak.OpenId.ClientAuthorizationScope("clientAuthorizationScopeResource", new()
{
RealmId = "string",
ResourceServerId = "string",
DisplayName = "string",
IconUri = "string",
Name = "string",
});
example, err := openid.NewClientAuthorizationScope(ctx, "clientAuthorizationScopeResource", &openid.ClientAuthorizationScopeArgs{
RealmId: pulumi.String("string"),
ResourceServerId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IconUri: pulumi.String("string"),
Name: pulumi.String("string"),
})
var clientAuthorizationScopeResource = new ClientAuthorizationScope("clientAuthorizationScopeResource", ClientAuthorizationScopeArgs.builder()
.realmId("string")
.resourceServerId("string")
.displayName("string")
.iconUri("string")
.name("string")
.build());
client_authorization_scope_resource = keycloak.openid.ClientAuthorizationScope("clientAuthorizationScopeResource",
realm_id="string",
resource_server_id="string",
display_name="string",
icon_uri="string",
name="string")
const clientAuthorizationScopeResource = new keycloak.openid.ClientAuthorizationScope("clientAuthorizationScopeResource", {
realmId: "string",
resourceServerId: "string",
displayName: "string",
iconUri: "string",
name: "string",
});
type: keycloak:openid:ClientAuthorizationScope
properties:
displayName: string
iconUri: string
name: string
realmId: string
resourceServerId: string
ClientAuthorizationScope 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 ClientAuthorizationScope resource accepts the following input properties:
- Realm
Id string - Resource
Server stringId - Display
Name string - Icon
Uri string - Name string
- Realm
Id string - Resource
Server stringId - Display
Name string - Icon
Uri string - Name string
- realm
Id String - resource
Server StringId - display
Name String - icon
Uri String - name String
- realm
Id string - resource
Server stringId - display
Name string - icon
Uri string - name string
- realm_
id str - resource_
server_ strid - display_
name str - icon_
uri str - name str
- realm
Id String - resource
Server StringId - display
Name String - icon
Uri String - name String
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientAuthorizationScope 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 ClientAuthorizationScope Resource
Get an existing ClientAuthorizationScope 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?: ClientAuthorizationScopeState, opts?: CustomResourceOptions): ClientAuthorizationScope@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
icon_uri: Optional[str] = None,
name: Optional[str] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None) -> ClientAuthorizationScopefunc GetClientAuthorizationScope(ctx *Context, name string, id IDInput, state *ClientAuthorizationScopeState, opts ...ResourceOption) (*ClientAuthorizationScope, error)public static ClientAuthorizationScope Get(string name, Input<string> id, ClientAuthorizationScopeState? state, CustomResourceOptions? opts = null)public static ClientAuthorizationScope get(String name, Output<String> id, ClientAuthorizationScopeState state, CustomResourceOptions options)resources: _: type: keycloak:openid:ClientAuthorizationScope get: id: ${id}- 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.
- Display
Name string - Icon
Uri string - Name string
- Realm
Id string - Resource
Server stringId
- Display
Name string - Icon
Uri string - Name string
- Realm
Id string - Resource
Server stringId
- display
Name String - icon
Uri String - name String
- realm
Id String - resource
Server StringId
- display
Name string - icon
Uri string - name string
- realm
Id string - resource
Server stringId
- display_
name str - icon_
uri str - name str
- realm_
id str - resource_
server_ strid
- display
Name String - icon
Uri String - name String
- realm
Id String - resource
Server StringId
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.