Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. RealmKeystoreRsa
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.RealmKeystoreRsa

Explore with Pulumi AI

Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

Allows for creating and managing rsa 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!

Coming soon!

Coming soon!

Coming soon!

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
  keystoreRsa:
    type: keycloak:RealmKeystoreRsa
    name: keystore_rsa
    properties:
      name: my-rsa-key
      realmId: ${realm.id}
      enabled: true
      active: true
      privateKey: <your rsa private key>
      certificate: <your certificate>
      priority: 100
      algorithm: RS256
      keystoreSize: 2048
      providerId: rsa
Copy

Create RealmKeystoreRsa Resource

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

Constructor syntax

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

@overload
def RealmKeystoreRsa(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     certificate: Optional[str] = None,
                     private_key: Optional[str] = None,
                     realm_id: Optional[str] = None,
                     active: Optional[bool] = None,
                     algorithm: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     priority: Optional[int] = None,
                     provider_id: Optional[str] = None)
func NewRealmKeystoreRsa(ctx *Context, name string, args RealmKeystoreRsaArgs, opts ...ResourceOption) (*RealmKeystoreRsa, error)
public RealmKeystoreRsa(string name, RealmKeystoreRsaArgs args, CustomResourceOptions? opts = null)
public RealmKeystoreRsa(String name, RealmKeystoreRsaArgs args)
public RealmKeystoreRsa(String name, RealmKeystoreRsaArgs args, CustomResourceOptions options)

type: keycloak:RealmKeystoreRsa
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. RealmKeystoreRsaArgs
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. RealmKeystoreRsaArgs
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. RealmKeystoreRsaArgs
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. RealmKeystoreRsaArgs
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. RealmKeystoreRsaArgs
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 realmKeystoreRsaResource = new Keycloak.RealmKeystoreRsa("realmKeystoreRsaResource", new()
{
    Certificate = "string",
    PrivateKey = "string",
    RealmId = "string",
    Active = false,
    Algorithm = "string",
    Enabled = false,
    Name = "string",
    Priority = 0,
    ProviderId = "string",
});
Copy
example, err := keycloak.NewRealmKeystoreRsa(ctx, "realmKeystoreRsaResource", &keycloak.RealmKeystoreRsaArgs{
	Certificate: pulumi.String("string"),
	PrivateKey:  pulumi.String("string"),
	RealmId:     pulumi.String("string"),
	Active:      pulumi.Bool(false),
	Algorithm:   pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	Priority:    pulumi.Int(0),
	ProviderId:  pulumi.String("string"),
})
Copy
var realmKeystoreRsaResource = new RealmKeystoreRsa("realmKeystoreRsaResource", RealmKeystoreRsaArgs.builder()
    .certificate("string")
    .privateKey("string")
    .realmId("string")
    .active(false)
    .algorithm("string")
    .enabled(false)
    .name("string")
    .priority(0)
    .providerId("string")
    .build());
Copy
realm_keystore_rsa_resource = keycloak.RealmKeystoreRsa("realmKeystoreRsaResource",
    certificate="string",
    private_key="string",
    realm_id="string",
    active=False,
    algorithm="string",
    enabled=False,
    name="string",
    priority=0,
    provider_id="string")
Copy
const realmKeystoreRsaResource = new keycloak.RealmKeystoreRsa("realmKeystoreRsaResource", {
    certificate: "string",
    privateKey: "string",
    realmId: "string",
    active: false,
    algorithm: "string",
    enabled: false,
    name: "string",
    priority: 0,
    providerId: "string",
});
Copy
type: keycloak:RealmKeystoreRsa
properties:
    active: false
    algorithm: string
    certificate: string
    enabled: false
    name: string
    priority: 0
    privateKey: string
    providerId: string
    realmId: string
Copy

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

Certificate This property is required. string
X509 Certificate encoded in PEM format.
PrivateKey This property is required. string
Private RSA Key encoded in PEM format.
RealmId
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
Enabled bool
When false, key is not accessible in this realm. Defaults to true.
Name string
Display name of provider when linked in admin console.
Priority int
Priority for the provider. Defaults to 0
ProviderId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
Certificate This property is required. string
X509 Certificate encoded in PEM format.
PrivateKey This property is required. string
Private RSA Key encoded in PEM format.
RealmId
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
Enabled bool
When false, key is not accessible in this realm. Defaults to true.
Name string
Display name of provider when linked in admin console.
Priority int
Priority for the provider. Defaults to 0
ProviderId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
certificate This property is required. String
X509 Certificate encoded in PEM format.
privateKey This property is required. String
Private RSA Key encoded in PEM format.
realmId
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
enabled Boolean
When false, key is not accessible in this realm. Defaults to true.
name String
Display name of provider when linked in admin console.
priority Integer
Priority for the provider. Defaults to 0
providerId Changes to this property will trigger replacement. String
Use rsa for signing keys, rsa-enc for encryption keys
certificate This property is required. string
X509 Certificate encoded in PEM format.
privateKey This property is required. string
Private RSA Key encoded in PEM format.
realmId
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
enabled boolean
When false, key is not accessible in this realm. Defaults to true.
name string
Display name of provider when linked in admin console.
priority number
Priority for the provider. Defaults to 0
providerId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
certificate This property is required. str
X509 Certificate encoded in PEM format.
private_key This property is required. str
Private RSA Key encoded in PEM format.
realm_id
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
enabled bool
When false, key is not accessible in this realm. Defaults to true.
name str
Display name of provider when linked in admin console.
priority int
Priority for the provider. Defaults to 0
provider_id Changes to this property will trigger replacement. str
Use rsa for signing keys, rsa-enc for encryption keys
certificate This property is required. String
X509 Certificate encoded in PEM format.
privateKey This property is required. String
Private RSA Key encoded in PEM format.
realmId
This property is required.
Changes to this property will trigger replacement.
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. Use RSA-OAEP for encryption keys
enabled Boolean
When false, key is not accessible in this realm. Defaults to true.
name String
Display name of provider when linked in admin console.
priority Number
Priority for the provider. Defaults to 0
providerId Changes to this property will trigger replacement. String
Use rsa for signing keys, rsa-enc for encryption keys

Outputs

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

Get an existing RealmKeystoreRsa 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?: RealmKeystoreRsaState, opts?: CustomResourceOptions): RealmKeystoreRsa
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        algorithm: Optional[str] = None,
        certificate: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        private_key: Optional[str] = None,
        provider_id: Optional[str] = None,
        realm_id: Optional[str] = None) -> RealmKeystoreRsa
func GetRealmKeystoreRsa(ctx *Context, name string, id IDInput, state *RealmKeystoreRsaState, opts ...ResourceOption) (*RealmKeystoreRsa, error)
public static RealmKeystoreRsa Get(string name, Input<string> id, RealmKeystoreRsaState? state, CustomResourceOptions? opts = null)
public static RealmKeystoreRsa get(String name, Output<String> id, RealmKeystoreRsaState state, CustomResourceOptions options)
resources:  _:    type: keycloak:RealmKeystoreRsa    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:
Active bool
When false, key in not used for signing. Defaults to true.
Algorithm string
Intended algorithm for the key. Defaults to RS256. Use RSA-OAEP for encryption keys
Certificate string
X509 Certificate encoded in PEM format.
Enabled bool
When false, key is not accessible in this realm. Defaults to true.
Name string
Display name of provider when linked in admin console.
Priority int
Priority for the provider. Defaults to 0
PrivateKey string
Private RSA Key encoded in PEM format.
ProviderId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
RealmId Changes to this property will trigger replacement. 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. Use RSA-OAEP for encryption keys
Certificate string
X509 Certificate encoded in PEM format.
Enabled bool
When false, key is not accessible in this realm. Defaults to true.
Name string
Display name of provider when linked in admin console.
Priority int
Priority for the provider. Defaults to 0
PrivateKey string
Private RSA Key encoded in PEM format.
ProviderId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
RealmId Changes to this property will trigger replacement. 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. Use RSA-OAEP for encryption keys
certificate String
X509 Certificate encoded in PEM format.
enabled Boolean
When false, key is not accessible in this realm. Defaults to true.
name String
Display name of provider when linked in admin console.
priority Integer
Priority for the provider. Defaults to 0
privateKey String
Private RSA Key encoded in PEM format.
providerId Changes to this property will trigger replacement. String
Use rsa for signing keys, rsa-enc for encryption keys
realmId Changes to this property will trigger replacement. 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. Use RSA-OAEP for encryption keys
certificate string
X509 Certificate encoded in PEM format.
enabled boolean
When false, key is not accessible in this realm. Defaults to true.
name string
Display name of provider when linked in admin console.
priority number
Priority for the provider. Defaults to 0
privateKey string
Private RSA Key encoded in PEM format.
providerId Changes to this property will trigger replacement. string
Use rsa for signing keys, rsa-enc for encryption keys
realmId Changes to this property will trigger replacement. 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. Use RSA-OAEP for encryption keys
certificate str
X509 Certificate encoded in PEM format.
enabled bool
When false, key is not accessible in this realm. Defaults to true.
name str
Display name of provider when linked in admin console.
priority int
Priority for the provider. Defaults to 0
private_key str
Private RSA Key encoded in PEM format.
provider_id Changes to this property will trigger replacement. str
Use rsa for signing keys, rsa-enc for encryption keys
realm_id Changes to this property will trigger replacement. 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. Use RSA-OAEP for encryption keys
certificate String
X509 Certificate encoded in PEM format.
enabled Boolean
When false, key is not accessible in this realm. Defaults to true.
name String
Display name of provider when linked in admin console.
priority Number
Priority for the provider. Defaults to 0
privateKey String
Private RSA Key encoded in PEM format.
providerId Changes to this property will trigger replacement. String
Use rsa for signing keys, rsa-enc for encryption keys
realmId Changes to this property will trigger replacement. 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.

Example:

bash

$ pulumi import keycloak:index/realmKeystoreRsa:RealmKeystoreRsa keystore_rsa my-realm/618cfba7-49aa-4c09-9a19-2f699b576f0b
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.
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak