1. Packages
  2. Keycloak Provider
  3. API Docs
  4. openid
  5. ClientScope
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi

keycloak.openid.ClientScope

Explore with Pulumi AI

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

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("openid_client_scope", {
    realmId: realm.id,
    name: "groups",
    description: "When requested, this scope will map a user's group memberships to a claim",
    includeInTokenScope: true,
    guiOrder: 1,
});
Copy
import pulumi
import pulumi_keycloak as keycloak

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

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/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, "openid_client_scope", &openid.ClientScopeArgs{
			RealmId:             realm.ID(),
			Name:                pulumi.String("groups"),
			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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
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("openid_client_scope", new()
    {
        RealmId = realm.Id,
        Name = "groups",
        Description = "When requested, this scope will map a user's group memberships to a claim",
        IncludeInTokenScope = true,
        GuiOrder = 1,
    });

});
Copy
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())
            .name("groups")
            .description("When requested, this scope will map a user's group memberships to a claim")
            .includeInTokenScope(true)
            .guiOrder(1)
            .build());

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

Create ClientScope Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClientScope(name: string, args: ClientScopeArgs, opts?: CustomResourceOptions);
@overload
def ClientScope(resource_name: str,
                args: ClientScopeArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ClientScope(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                realm_id: Optional[str] = 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)
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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClientScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ClientScopeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClientScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClientScopeArgs
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 clientScopeResource = new Keycloak.OpenId.ClientScope("clientScopeResource", new()
{
    RealmId = "string",
    ConsentScreenText = "string",
    Description = "string",
    GuiOrder = 0,
    IncludeInTokenScope = false,
    Name = "string",
});
Copy
example, err := openid.NewClientScope(ctx, "clientScopeResource", &openid.ClientScopeArgs{
	RealmId:             pulumi.String("string"),
	ConsentScreenText:   pulumi.String("string"),
	Description:         pulumi.String("string"),
	GuiOrder:            pulumi.Int(0),
	IncludeInTokenScope: pulumi.Bool(false),
	Name:                pulumi.String("string"),
})
Copy
var clientScopeResource = new ClientScope("clientScopeResource", ClientScopeArgs.builder()
    .realmId("string")
    .consentScreenText("string")
    .description("string")
    .guiOrder(0)
    .includeInTokenScope(false)
    .name("string")
    .build());
Copy
client_scope_resource = keycloak.openid.ClientScope("clientScopeResource",
    realm_id="string",
    consent_screen_text="string",
    description="string",
    gui_order=0,
    include_in_token_scope=False,
    name="string")
Copy
const clientScopeResource = new keycloak.openid.ClientScope("clientScopeResource", {
    realmId: "string",
    consentScreenText: "string",
    description: "string",
    guiOrder: 0,
    includeInTokenScope: false,
    name: "string",
});
Copy
type: keycloak:openid:ClientScope
properties:
    consentScreenText: string
    description: string
    guiOrder: 0
    includeInTokenScope: false
    name: string
    realmId: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ClientScope resource accepts the following input properties:

RealmId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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)
resources:  _:    type: keycloak:openid:ClientScope    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Example:

bash

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.