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

ClientScope

# 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

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

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

import pulumi
import pulumi_keycloak as keycloak

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

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
        {
            Enabled = true,
            Realm = "my-realm",
        });
        var openidClientScope = new Keycloak.OpenId.ClientScope("openidClientScope", new Keycloak.OpenId.ClientScopeArgs
        {
            Description = "When requested, this scope will map a user's group memberships to a claim",
            RealmId = realm.Id,
        });
    }

}

Argument Reference

The following arguments are supported:

• realm_id - (Required) The realm this client scope belongs to.
• name - (Required) The display name of this client scope in the GUI.
• description - (Optional) The description of this client scope in the GUI.
• consent_screen_text - (Optional) 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.

Create a ClientScope Resource

new ClientScope(name: string, args: ClientScopeArgs, opts?: CustomResourceOptions);

def ClientScope(resource_name, opts=None, consent_screen_text=None, description=None, name=None, realm_id=None, __props__=None);

func NewClientScope(ctx *Context, name string, args ClientScopeArgs, opts ...ResourceOption) (*ClientScope, error)

public ClientScope(string name, ClientScopeArgs args, CustomResourceOptions? opts = null)

ClientScope Resource Properties

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

Inputs

The ClientScope resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the ClientScope resource produces the following output properties:

Look up an 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

static get(resource_name, id, opts=None, consent_screen_text=None, description=None, name=None, realm_id=None, __props__=None);

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)

The following state arguments are supported:

Package Details

Repository

https://github.com/pulumi/pulumi-keycloak

License

Apache-2.0

Notes

This Pulumi package is based on the keycloak Terraform Provider.