Keycloak

Pulumi Official
Package maintained by Pulumi
v4.8.0 published on Monday, Apr 4, 2022 by Pulumi

ClientDefaultScopes

Import

This resource does not support import. Instead of importing, feel free to create this resource as if it did not already exist on the server.

Example Usage

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
        {
            Realm = "my-realm",
            Enabled = true,
        });
        var client = new Keycloak.OpenId.Client("client", new Keycloak.OpenId.ClientArgs
        {
            RealmId = realm.Id,
            ClientId = "test-client",
            AccessType = "CONFIDENTIAL",
        });
        var clientScope = new Keycloak.OpenId.ClientScope("clientScope", new Keycloak.OpenId.ClientScopeArgs
        {
            RealmId = realm.Id,
        });
        var clientDefaultScopes = new Keycloak.OpenId.ClientDefaultScopes("clientDefaultScopes", new Keycloak.OpenId.ClientDefaultScopesArgs
        {
            RealmId = realm.Id,
            ClientId = client.Id,
            DefaultScopes = 
            {
                "profile",
                "email",
                "roles",
                "web-origins",
                clientScope.Name,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v4/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v4/go/keycloak/openid"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
			Realm:   pulumi.String("my-realm"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		client, err := openid.NewClient(ctx, "client", &openid.ClientArgs{
			RealmId:    realm.ID(),
			ClientId:   pulumi.String("test-client"),
			AccessType: pulumi.String("CONFIDENTIAL"),
		})
		if err != nil {
			return err
		}
		clientScope, err := openid.NewClientScope(ctx, "clientScope", &openid.ClientScopeArgs{
			RealmId: realm.ID(),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewClientDefaultScopes(ctx, "clientDefaultScopes", &openid.ClientDefaultScopesArgs{
			RealmId:  realm.ID(),
			ClientId: client.ID(),
			DefaultScopes: pulumi.StringArray{
				pulumi.String("profile"),
				pulumi.String("email"),
				pulumi.String("roles"),
				pulumi.String("web-origins"),
				clientScope.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
client = keycloak.openid.Client("client",
    realm_id=realm.id,
    client_id="test-client",
    access_type="CONFIDENTIAL")
client_scope = keycloak.openid.ClientScope("clientScope", realm_id=realm.id)
client_default_scopes = keycloak.openid.ClientDefaultScopes("clientDefaultScopes",
    realm_id=realm.id,
    client_id=client.id,
    default_scopes=[
        "profile",
        "email",
        "roles",
        "web-origins",
        client_scope.name,
    ])
import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const client = new keycloak.openid.Client("client", {
    realmId: realm.id,
    clientId: "test-client",
    accessType: "CONFIDENTIAL",
});
const clientScope = new keycloak.openid.ClientScope("clientScope", {realmId: realm.id});
const clientDefaultScopes = new keycloak.openid.ClientDefaultScopes("clientDefaultScopes", {
    realmId: realm.id,
    clientId: client.id,
    defaultScopes: [
        "profile",
        "email",
        "roles",
        "web-origins",
        clientScope.name,
    ],
});

Coming soon!

Create a ClientDefaultScopes Resource

new ClientDefaultScopes(name: string, args: ClientDefaultScopesArgs, opts?: CustomResourceOptions);
@overload
def ClientDefaultScopes(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        client_id: Optional[str] = None,
                        default_scopes: Optional[Sequence[str]] = None,
                        realm_id: Optional[str] = None)
@overload
def ClientDefaultScopes(resource_name: str,
                        args: ClientDefaultScopesArgs,
                        opts: Optional[ResourceOptions] = None)
func NewClientDefaultScopes(ctx *Context, name string, args ClientDefaultScopesArgs, opts ...ResourceOption) (*ClientDefaultScopes, error)
public ClientDefaultScopes(string name, ClientDefaultScopesArgs args, CustomResourceOptions? opts = null)
public ClientDefaultScopes(String name, ClientDefaultScopesArgs args)
public ClientDefaultScopes(String name, ClientDefaultScopesArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientDefaultScopes
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

ClientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

DefaultScopes List<string>

An array of client scope names to attach to this client.

RealmId string

The realm this client and scopes exists in.

ClientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

DefaultScopes []string

An array of client scope names to attach to this client.

RealmId string

The realm this client and scopes exists in.

clientId String

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes List

An array of client scope names to attach to this client.

realmId String

The realm this client and scopes exists in.

clientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes string[]

An array of client scope names to attach to this client.

realmId string

The realm this client and scopes exists in.

client_id str

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

default_scopes Sequence[str]

An array of client scope names to attach to this client.

realm_id str

The realm this client and scopes exists in.

clientId String

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes List

An array of client scope names to attach to this client.

realmId String

The realm this client and scopes exists in.

Outputs

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

Get an existing ClientDefaultScopes 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?: ClientDefaultScopesState, opts?: CustomResourceOptions): ClientDefaultScopes
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        default_scopes: Optional[Sequence[str]] = None,
        realm_id: Optional[str] = None) -> ClientDefaultScopes
func GetClientDefaultScopes(ctx *Context, name string, id IDInput, state *ClientDefaultScopesState, opts ...ResourceOption) (*ClientDefaultScopes, error)
public static ClientDefaultScopes Get(string name, Input<string> id, ClientDefaultScopesState? state, CustomResourceOptions? opts = null)
public static ClientDefaultScopes get(String name, Output<String> id, ClientDefaultScopesState 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:
ClientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

DefaultScopes List<string>

An array of client scope names to attach to this client.

RealmId string

The realm this client and scopes exists in.

ClientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

DefaultScopes []string

An array of client scope names to attach to this client.

RealmId string

The realm this client and scopes exists in.

clientId String

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes List

An array of client scope names to attach to this client.

realmId String

The realm this client and scopes exists in.

clientId string

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes string[]

An array of client scope names to attach to this client.

realmId string

The realm this client and scopes exists in.

client_id str

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

default_scopes Sequence[str]

An array of client scope names to attach to this client.

realm_id str

The realm this client and scopes exists in.

clientId String

The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.

defaultScopes List

An array of client scope names to attach to this client.

realmId String

The realm this client and scopes exists in.

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes

This Pulumi package is based on the keycloak Terraform Provider.