1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. openid
  6. ClientOptionalScopes

ClientOptionalScopes

Create a ClientOptionalScopes Resource

new ClientOptionalScopes(name: string, args: ClientOptionalScopesArgs, opts?: CustomResourceOptions);
def ClientOptionalScopes(resource_name, opts=None, client_id=None, optional_scopes=None, realm_id=None, __props__=None);
func NewClientOptionalScopes(ctx *Context, name string, args ClientOptionalScopesArgs, opts ...ResourceOption) (*ClientOptionalScopes, error)
public ClientOptionalScopes(string name, ClientOptionalScopesArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ClientOptionalScopesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClientOptionalScopesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClientOptionalScopesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ClientOptionalScopes Resource Properties

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

Inputs

The ClientOptionalScopes resource accepts the following input properties:

ClientId string
OptionalScopes List<string>
RealmId string
ClientId string
OptionalScopes []string
RealmId string
clientId string
optionalScopes string[]
realmId string
client_id str
optional_scopes List[str]
realm_id str

Outputs

All input properties are implicitly available as output properties. Additionally, the ClientOptionalScopes 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing ClientOptionalScopes Resource

Get an existing ClientOptionalScopes 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?: ClientOptionalScopesState, opts?: CustomResourceOptions): ClientOptionalScopes
static get(resource_name, id, opts=None, client_id=None, optional_scopes=None, realm_id=None, __props__=None);
func GetClientOptionalScopes(ctx *Context, name string, id IDInput, state *ClientOptionalScopesState, opts ...ResourceOption) (*ClientOptionalScopes, error)
public static ClientOptionalScopes Get(string name, Input<string> id, ClientOptionalScopesState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

ClientId string
OptionalScopes List<string>
RealmId string
ClientId string
OptionalScopes []string
RealmId string
clientId string
optionalScopes string[]
realmId string
client_id str
optional_scopes List[str]
realm_id str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.