Class 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

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.

Inheritance

System.Object

Resource

CustomResource

ClientScope

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak.OpenId

Assembly: Pulumi.Keycloak.dll

Syntax

public class ClientScope : CustomResource

Constructors

ClientScope(String, ClientScopeArgs, CustomResourceOptions)

Create a ClientScope resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClientScopeArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ConsentScreenText

Declaration

public Output<string> ConsentScreenText { get; }

Property Value

Type	Description
Output<System.String>

Description

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Name

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RealmId

Declaration

public Output<string> RealmId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ClientScopeState, CustomResourceOptions)

Get an existing ClientScope resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ClientScope Get(string name, Input<string> id, ClientScopeState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClientScopeState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClientScope