Keycloak v5.3.5, Oct 16 24

Keycloak v5.3.5 published on Wednesday, Oct 16, 2024 by Pulumi

keycloak.openid.ClientAuthorizationResource

Explore with Pulumi AI

Keycloak v5.3.5 published on Wednesday, Oct 16, 2024 by Pulumi

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 string: The unique name of the resource.
args ClientAuthorizationResourceArgs: 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 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 string: The unique name of the resource.
args ClientAuthorizationResourceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClientAuthorizationResourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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:

RealmId string
ResourceServerId string
Attributes Dictionary<string, string>
DisplayName string
IconUri string
Name string
OwnerManagedAccess bool
Scopes List<string>
Type string
Uris List<string>

RealmId string
ResourceServerId string
Attributes map[string]string
DisplayName string
IconUri string
Name string
OwnerManagedAccess bool
Scopes []string
Type string
Uris []string

realmId String
resourceServerId String
attributes Map<String,String>
displayName String
iconUri String
name String
ownerManagedAccess Boolean
scopes List<String>
type String
uris List<String>

realmId string
resourceServerId string
attributes {[key: string]: string}
displayName string
iconUri string
name string
ownerManagedAccess boolean
scopes string[]
type string
uris string[]

realm_id str
resource_server_id str
attributes Mapping[str, str]
display_name str
icon_uri str
name str
owner_managed_access bool
scopes Sequence[str]
type str
uris Sequence[str]

realmId String
resourceServerId String
attributes Map<String>
displayName String
iconUri String
name String
ownerManagedAccess Boolean
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) -> ClientAuthorizationResource

func 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)

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:

Attributes Dictionary<string, string>
DisplayName string
IconUri string
Name string
OwnerManagedAccess bool
RealmId string
ResourceServerId string
Scopes List<string>
Type string
Uris List<string>

Attributes map[string]string
DisplayName string
IconUri string
Name string
OwnerManagedAccess bool
RealmId string
ResourceServerId string
Scopes []string
Type string
Uris []string

attributes Map<String,String>
displayName String
iconUri String
name String
ownerManagedAccess Boolean
realmId String
resourceServerId String
scopes List<String>
type String
uris List<String>

attributes {[key: string]: string}
displayName string
iconUri string
name string
ownerManagedAccess boolean
realmId string
resourceServerId string
scopes string[]
type string
uris string[]

attributes Mapping[str, str]
display_name str
icon_uri str
name str
owner_managed_access bool
realm_id str
resource_server_id str
scopes Sequence[str]
type str
uris Sequence[str]

attributes Map<String>
displayName String
iconUri String
name String
ownerManagedAccess Boolean
realmId String
resourceServerId String
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 keycloak Terraform Provider.

Keycloak v5.3.5 published on Wednesday, Oct 16, 2024 by Pulumi

pulumi/pulumi-keycloak

keycloak.openid.ClientAuthorizationResource

On this page

On this page

Create ClientAuthorizationResource Resource

Constructor syntax

Parameters

Constructor example

ClientAuthorizationResource Resource Properties

Inputs

Outputs

Look up Existing ClientAuthorizationResource Resource

Package Details

On this page

On this page