1. Pulumi Registry
  2. Keycloak
  3. API Docs
  4. openid
  5. ClientScope
keycloak logo
Keycloak v5.1.0, Mar 14 23

keycloak.openid.ClientScope

Allows for creating and managing Keycloak client scopes that can be attached to clients that use the OpenID Connect protocol.

Client Scopes can be used to share common protocol and role mappings between multiple clients within a realm. They can also be used by clients to conditionally request claims or roles for a user based on the OAuth 2.0 scope parameter.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Keycloak = Pulumi.Keycloak;

return await Deployment.RunAsync(() => 
{
    var realm = new Keycloak.Realm("realm", new()
    {
        RealmName = "my-realm",
        Enabled = true,
    });

    var openidClientScope = new Keycloak.OpenId.ClientScope("openidClientScope", new()
    {
        RealmId = realm.Id,
        Description = "When requested, this scope will map a user's group memberships to a claim",
        IncludeInTokenScope = true,
        GuiOrder = 1,
    });

});

package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v5/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
		}
		_, err = openid.NewClientScope(ctx, "openidClientScope", &openid.ClientScopeArgs{
			RealmId:             realm.ID(),
			Description:         pulumi.String("When requested, this scope will map a user's group memberships to a claim"),
			IncludeInTokenScope: pulumi.Bool(true),
			GuiOrder:            pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.openid.ClientScope;
import com.pulumi.keycloak.openid.ClientScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var realm = new Realm("realm", RealmArgs.builder()        
            .realm("my-realm")
            .enabled(true)
            .build());

        var openidClientScope = new ClientScope("openidClientScope", ClientScopeArgs.builder()        
            .realmId(realm.id())
            .description("When requested, this scope will map a user's group memberships to a claim")
            .includeInTokenScope(true)
            .guiOrder(1)
            .build());

    }
}

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
openid_client_scope = keycloak.openid.ClientScope("openidClientScope",
    realm_id=realm.id,
    description="When requested, this scope will map a user's group memberships to a claim",
    include_in_token_scope=True,
    gui_order=1)

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const openidClientScope = new keycloak.openid.ClientScope("openidClientScope", {
    realmId: realm.id,
    description: "When requested, this scope will map a user's group memberships to a claim",
    includeInTokenScope: true,
    guiOrder: 1,
});

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  openidClientScope:
    type: keycloak:openid:ClientScope
    properties:
      realmId: ${realm.id}
      description: When requested, this scope will map a user's group memberships to a claim
      includeInTokenScope: true
      guiOrder: 1

Create ClientScope Resource

new ClientScope(name: string, args: ClientScopeArgs, opts?: CustomResourceOptions);
@overload
def ClientScope(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                consent_screen_text: Optional[str] = None,
                description: Optional[str] = None,
                gui_order: Optional[int] = None,
                include_in_token_scope: Optional[bool] = None,
                name: Optional[str] = None,
                realm_id: Optional[str] = None)
@overload
def ClientScope(resource_name: str,
                args: ClientScopeArgs,
                opts: Optional[ResourceOptions] = None)
func NewClientScope(ctx *Context, name string, args ClientScopeArgs, opts ...ResourceOption) (*ClientScope, error)
public ClientScope(string name, ClientScopeArgs args, CustomResourceOptions? opts = null)
public ClientScope(String name, ClientScopeArgs args)
public ClientScope(String name, ClientScopeArgs args, CustomResourceOptions options)

type: keycloak:openid:ClientScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClientScopeArgs
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 ClientScopeArgs
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 ClientScopeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClientScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClientScopeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

RealmId string

The realm this client scope belongs to.

ConsentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

Description string

The description of this client scope in the GUI.

GuiOrder int

Specify order of the client scope in GUI (such as in Consent page) as integer.

IncludeInTokenScope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

Name string

The display name of this client scope in the GUI.

RealmId string

The realm this client scope belongs to.

ConsentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

Description string

The description of this client scope in the GUI.

GuiOrder int

Specify order of the client scope in GUI (such as in Consent page) as integer.

IncludeInTokenScope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

Name string

The display name of this client scope in the GUI.

realmId String

The realm this client scope belongs to.

consentScreenText String

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description String

The description of this client scope in the GUI.

guiOrder Integer

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope Boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name String

The display name of this client scope in the GUI.

realmId string

The realm this client scope belongs to.

consentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description string

The description of this client scope in the GUI.

guiOrder number

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name string

The display name of this client scope in the GUI.

realm_id str

The realm this client scope belongs to.

consent_screen_text str

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description str

The description of this client scope in the GUI.

gui_order int

Specify order of the client scope in GUI (such as in Consent page) as integer.

include_in_token_scope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name str

The display name of this client scope in the GUI.

realmId String

The realm this client scope belongs to.

consentScreenText String

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description String

The description of this client scope in the GUI.

guiOrder Number

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope Boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name String

The display name of this client scope in the GUI.

Outputs

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

Get an existing ClientScope 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?: ClientScopeState, opts?: CustomResourceOptions): ClientScope
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consent_screen_text: Optional[str] = None,
        description: Optional[str] = None,
        gui_order: Optional[int] = None,
        include_in_token_scope: Optional[bool] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None) -> ClientScope
func GetClientScope(ctx *Context, name string, id IDInput, state *ClientScopeState, opts ...ResourceOption) (*ClientScope, error)
public static ClientScope Get(string name, Input<string> id, ClientScopeState? state, CustomResourceOptions? opts = null)
public static ClientScope get(String name, Output<String> id, ClientScopeState 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:
ConsentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

Description string

The description of this client scope in the GUI.

GuiOrder int

Specify order of the client scope in GUI (such as in Consent page) as integer.

IncludeInTokenScope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

Name string

The display name of this client scope in the GUI.

RealmId string

The realm this client scope belongs to.

ConsentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

Description string

The description of this client scope in the GUI.

GuiOrder int

Specify order of the client scope in GUI (such as in Consent page) as integer.

IncludeInTokenScope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

Name string

The display name of this client scope in the GUI.

RealmId string

The realm this client scope belongs to.

consentScreenText String

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description String

The description of this client scope in the GUI.

guiOrder Integer

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope Boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name String

The display name of this client scope in the GUI.

realmId String

The realm this client scope belongs to.

consentScreenText string

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description string

The description of this client scope in the GUI.

guiOrder number

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name string

The display name of this client scope in the GUI.

realmId string

The realm this client scope belongs to.

consent_screen_text str

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description str

The description of this client scope in the GUI.

gui_order int

Specify order of the client scope in GUI (such as in Consent page) as integer.

include_in_token_scope bool

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name str

The display name of this client scope in the GUI.

realm_id str

The realm this client scope belongs to.

consentScreenText String

When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.

description String

The description of this client scope in the GUI.

guiOrder Number

Specify order of the client scope in GUI (such as in Consent page) as integer.

includeInTokenScope Boolean

When true, the name of this client scope will be added to the access token property 'scope' as well as to the Token Introspection Endpoint response.

name String

The display name of this client scope in the GUI.

realmId String

The realm this client scope belongs to.

Import

Client scopes can be imported using the format {{realm_id}}/{{client_scope_id}}, where client_scope_id is the unique ID that Keycloak assigns to the client scope upon creation. This value can be found in the URI when editing this client scope in the GUI, and is typically a GUID. Examplebash

 $ pulumi import keycloak:openid/clientScope:ClientScope openid_client_scope my-realm/8e8f7fe1-df9b-40ed-bed3-4597aa0dac52

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes

This Pulumi package is based on the keycloak Terraform Provider.