keycloak logo
Keycloak v5.0.0, Jan 25 23

keycloak.RealmKeystoreRsaGenerated

Allows for creating and managing rsa-generated Realm keystores within Keycloak.

A realm keystore manages generated key pairs that are used by Keycloak to perform cryptographic signatures and encryption.

Example Usage

Coming soon!

Coming soon!

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.RealmKeystoreRsaGenerated;
import com.pulumi.keycloak.RealmKeystoreRsaGeneratedArgs;
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")
            .build());

        var keystoreRsaGenerated = new RealmKeystoreRsaGenerated("keystoreRsaGenerated", RealmKeystoreRsaGeneratedArgs.builder()        
            .realmId(realm.id())
            .enabled(true)
            .active(true)
            .priority(100)
            .algorithm("RS256")
            .keystoreSize(2048)
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
  keystoreRsaGenerated:
    type: keycloak:RealmKeystoreRsaGenerated
    properties:
      realmId: ${realm.id}
      enabled: true
      active: true
      priority: 100
      algorithm: RS256
      keystoreSize: 2048

Create RealmKeystoreRsaGenerated Resource

new RealmKeystoreRsaGenerated(name: string, args: RealmKeystoreRsaGeneratedArgs, opts?: CustomResourceOptions);
@overload
def RealmKeystoreRsaGenerated(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              active: Optional[bool] = None,
                              algorithm: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              key_size: Optional[int] = None,
                              name: Optional[str] = None,
                              priority: Optional[int] = None,
                              realm_id: Optional[str] = None)
@overload
def RealmKeystoreRsaGenerated(resource_name: str,
                              args: RealmKeystoreRsaGeneratedArgs,
                              opts: Optional[ResourceOptions] = None)
func NewRealmKeystoreRsaGenerated(ctx *Context, name string, args RealmKeystoreRsaGeneratedArgs, opts ...ResourceOption) (*RealmKeystoreRsaGenerated, error)
public RealmKeystoreRsaGenerated(string name, RealmKeystoreRsaGeneratedArgs args, CustomResourceOptions? opts = null)
public RealmKeystoreRsaGenerated(String name, RealmKeystoreRsaGeneratedArgs args)
public RealmKeystoreRsaGenerated(String name, RealmKeystoreRsaGeneratedArgs args, CustomResourceOptions options)
type: keycloak:RealmKeystoreRsaGenerated
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RealmKeystoreRsaGeneratedArgs
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 RealmKeystoreRsaGeneratedArgs
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 RealmKeystoreRsaGeneratedArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RealmKeystoreRsaGeneratedArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RealmKeystoreRsaGeneratedArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

RealmId string

The realm this keystore exists in.

Active bool

When false, key in not used for signing. Defaults to true.

Algorithm string

Intended algorithm for the key. Defaults to RS256

Enabled bool

When false, key is not accessible in this realm. Defaults to true.

KeySize int

Size for the generated keys

Name string

Display name of provider when linked in admin console.

Priority int

Priority for the provider. Defaults to 0

RealmId string

The realm this keystore exists in.

Active bool

When false, key in not used for signing. Defaults to true.

Algorithm string

Intended algorithm for the key. Defaults to RS256

Enabled bool

When false, key is not accessible in this realm. Defaults to true.

KeySize int

Size for the generated keys

Name string

Display name of provider when linked in admin console.

Priority int

Priority for the provider. Defaults to 0

realmId String

The realm this keystore exists in.

active Boolean

When false, key in not used for signing. Defaults to true.

algorithm String

Intended algorithm for the key. Defaults to RS256

enabled Boolean

When false, key is not accessible in this realm. Defaults to true.

keySize Integer

Size for the generated keys

name String

Display name of provider when linked in admin console.

priority Integer

Priority for the provider. Defaults to 0

realmId string

The realm this keystore exists in.

active boolean

When false, key in not used for signing. Defaults to true.

algorithm string

Intended algorithm for the key. Defaults to RS256

enabled boolean

When false, key is not accessible in this realm. Defaults to true.

keySize number

Size for the generated keys

name string

Display name of provider when linked in admin console.

priority number

Priority for the provider. Defaults to 0

realm_id str

The realm this keystore exists in.

active bool

When false, key in not used for signing. Defaults to true.

algorithm str

Intended algorithm for the key. Defaults to RS256

enabled bool

When false, key is not accessible in this realm. Defaults to true.

key_size int

Size for the generated keys

name str

Display name of provider when linked in admin console.

priority int

Priority for the provider. Defaults to 0

realmId String

The realm this keystore exists in.

active Boolean

When false, key in not used for signing. Defaults to true.

algorithm String

Intended algorithm for the key. Defaults to RS256

enabled Boolean

When false, key is not accessible in this realm. Defaults to true.

keySize Number

Size for the generated keys

name String

Display name of provider when linked in admin console.

priority Number

Priority for the provider. Defaults to 0

Outputs

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

Get an existing RealmKeystoreRsaGenerated 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?: RealmKeystoreRsaGeneratedState, opts?: CustomResourceOptions): RealmKeystoreRsaGenerated
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        algorithm: Optional[str] = None,
        enabled: Optional[bool] = None,
        key_size: Optional[int] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        realm_id: Optional[str] = None) -> RealmKeystoreRsaGenerated
func GetRealmKeystoreRsaGenerated(ctx *Context, name string, id IDInput, state *RealmKeystoreRsaGeneratedState, opts ...ResourceOption) (*RealmKeystoreRsaGenerated, error)
public static RealmKeystoreRsaGenerated Get(string name, Input<string> id, RealmKeystoreRsaGeneratedState? state, CustomResourceOptions? opts = null)
public static RealmKeystoreRsaGenerated get(String name, Output<String> id, RealmKeystoreRsaGeneratedState 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:
Active bool

When false, key in not used for signing. Defaults to true.

Algorithm string

Intended algorithm for the key. Defaults to RS256

Enabled bool

When false, key is not accessible in this realm. Defaults to true.

KeySize int

Size for the generated keys

Name string

Display name of provider when linked in admin console.

Priority int

Priority for the provider. Defaults to 0

RealmId string

The realm this keystore exists in.

Active bool

When false, key in not used for signing. Defaults to true.

Algorithm string

Intended algorithm for the key. Defaults to RS256

Enabled bool

When false, key is not accessible in this realm. Defaults to true.

KeySize int

Size for the generated keys

Name string

Display name of provider when linked in admin console.

Priority int

Priority for the provider. Defaults to 0

RealmId string

The realm this keystore exists in.

active Boolean

When false, key in not used for signing. Defaults to true.

algorithm String

Intended algorithm for the key. Defaults to RS256

enabled Boolean

When false, key is not accessible in this realm. Defaults to true.

keySize Integer

Size for the generated keys

name String

Display name of provider when linked in admin console.

priority Integer

Priority for the provider. Defaults to 0

realmId String

The realm this keystore exists in.

active boolean

When false, key in not used for signing. Defaults to true.

algorithm string

Intended algorithm for the key. Defaults to RS256

enabled boolean

When false, key is not accessible in this realm. Defaults to true.

keySize number

Size for the generated keys

name string

Display name of provider when linked in admin console.

priority number

Priority for the provider. Defaults to 0

realmId string

The realm this keystore exists in.

active bool

When false, key in not used for signing. Defaults to true.

algorithm str

Intended algorithm for the key. Defaults to RS256

enabled bool

When false, key is not accessible in this realm. Defaults to true.

key_size int

Size for the generated keys

name str

Display name of provider when linked in admin console.

priority int

Priority for the provider. Defaults to 0

realm_id str

The realm this keystore exists in.

active Boolean

When false, key in not used for signing. Defaults to true.

algorithm String

Intended algorithm for the key. Defaults to RS256

enabled Boolean

When false, key is not accessible in this realm. Defaults to true.

keySize Number

Size for the generated keys

name String

Display name of provider when linked in admin console.

priority Number

Priority for the provider. Defaults to 0

realmId String

The realm this keystore exists in.

Import

Realm keys can be imported using realm name and keystore id, you can find it in web UI. Examplebash

 $ pulumi import keycloak:index/realmKeystoreRsaGenerated:RealmKeystoreRsaGenerated keystore_rsa_generated my-realm/618cfba7-49aa-4c09-9a19-2f699b576f0b

Package Details

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

This Pulumi package is based on the keycloak Terraform Provider.