Client Optional Scopes
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 client = new keycloak.openid.Client("client", {
realmId: realm.id,
clientId: "test-client",
accessType: "CONFIDENTIAL",
});
const clientScope = new keycloak.openid.ClientScope("client_scope", {
realmId: realm.id,
name: "test-client-scope",
});
const clientOptionalScopes = new keycloak.openid.ClientOptionalScopes("client_optional_scopes", {
realmId: realm.id,
clientId: client.id,
optionalScopes: [
"address",
"phone",
"offline_access",
clientScope.name,
],
});Content copied to clipboard
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("client_scope",
realm_id=realm.id,
name="test-client-scope")
client_optional_scopes = keycloak.openid.ClientOptionalScopes("client_optional_scopes",
realm_id=realm.id,
client_id=client.id,
optional_scopes=[
"address",
"phone",
"offline_access",
client_scope.name,
])Content copied to clipboard
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 client = new Keycloak.OpenId.Client("client", new()
{
RealmId = realm.Id,
ClientId = "test-client",
AccessType = "CONFIDENTIAL",
});
var clientScope = new Keycloak.OpenId.ClientScope("client_scope", new()
{
RealmId = realm.Id,
Name = "test-client-scope",
});
var clientOptionalScopes = new Keycloak.OpenId.ClientOptionalScopes("client_optional_scopes", new()
{
RealmId = realm.Id,
ClientId = client.Id,
OptionalScopes = new[]
{
"address",
"phone",
"offline_access",
clientScope.Name,
},
});
});Content copied to clipboard
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
}
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, "client_scope", &openid.ClientScopeArgs{
RealmId: realm.ID(),
Name: pulumi.String("test-client-scope"),
})
if err != nil {
return err
}
_, err = openid.NewClientOptionalScopes(ctx, "client_optional_scopes", &openid.ClientOptionalScopesArgs{
RealmId: realm.ID(),
ClientId: client.ID(),
OptionalScopes: pulumi.StringArray{
pulumi.String("address"),
pulumi.String("phone"),
pulumi.String("offline_access"),
clientScope.Name,
},
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
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.Client;
import com.pulumi.keycloak.openid.ClientArgs;
import com.pulumi.keycloak.openid.ClientScope;
import com.pulumi.keycloak.openid.ClientScopeArgs;
import com.pulumi.keycloak.openid.ClientOptionalScopes;
import com.pulumi.keycloak.openid.ClientOptionalScopesArgs;
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 client = new Client("client", ClientArgs.builder()
.realmId(realm.id())
.clientId("test-client")
.accessType("CONFIDENTIAL")
.build());
var clientScope = new ClientScope("clientScope", ClientScopeArgs.builder()
.realmId(realm.id())
.name("test-client-scope")
.build());
var clientOptionalScopes = new ClientOptionalScopes("clientOptionalScopes", ClientOptionalScopesArgs.builder()
.realmId(realm.id())
.clientId(client.id())
.optionalScopes(
"address",
"phone",
"offline_access",
clientScope.name())
.build());
}
}Content copied to clipboard
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
client:
type: keycloak:openid:Client
properties:
realmId: ${realm.id}
clientId: test-client
accessType: CONFIDENTIAL
clientScope:
type: keycloak:openid:ClientScope
name: client_scope
properties:
realmId: ${realm.id}
name: test-client-scope
clientOptionalScopes:
type: keycloak:openid:ClientOptionalScopes
name: client_optional_scopes
properties:
realmId: ${realm.id}
clientId: ${client.id}
optionalScopes:
- address
- phone
- offline_access
- ${clientScope.name}Content copied to clipboard
Argument Reference
The following arguments are supported:
realm_id- (Required) The realm this client and scopes exists in.client_id- (Required) The ID of the client to attach optional scopes to. Note that this is the unique ID of the client generated by Keycloak.optional_scopes- (Required) An array of client scope names to attach to this client as optional scopes.
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.