Keycloak v5.1.0, Mar 14 23

keycloak.RealmKeystoreJavaGenerated

Allows for creating and managing java-keystore Realm keystores within Keycloak.

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

Create RealmKeystoreJavaGenerated Resource

new RealmKeystoreJavaGenerated(name: string, args: RealmKeystoreJavaGeneratedArgs, opts?: CustomResourceOptions);

@overload
def RealmKeystoreJavaGenerated(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               active: Optional[bool] = None,
                               algorithm: Optional[str] = None,
                               enabled: Optional[bool] = None,
                               key_alias: Optional[str] = None,
                               key_password: Optional[str] = None,
                               keystore: Optional[str] = None,
                               keystore_password: Optional[str] = None,
                               name: Optional[str] = None,
                               priority: Optional[int] = None,
                               realm_id: Optional[str] = None)
@overload
def RealmKeystoreJavaGenerated(resource_name: str,
                               args: RealmKeystoreJavaGeneratedArgs,
                               opts: Optional[ResourceOptions] = None)

func NewRealmKeystoreJavaGenerated(ctx *Context, name string, args RealmKeystoreJavaGeneratedArgs, opts ...ResourceOption) (*RealmKeystoreJavaGenerated, error)

public RealmKeystoreJavaGenerated(string name, RealmKeystoreJavaGeneratedArgs args, CustomResourceOptions? opts = null)

public RealmKeystoreJavaGenerated(String name, RealmKeystoreJavaGeneratedArgs args)
public RealmKeystoreJavaGenerated(String name, RealmKeystoreJavaGeneratedArgs args, CustomResourceOptions options)

type: keycloak:RealmKeystoreJavaGenerated
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args RealmKeystoreJavaGeneratedArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RealmKeystoreJavaGeneratedArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

KeyAlias string: Alias for the private key
KeyPassword string: Password for the private key
Keystore string: Path to keys file on keycloak instance.
KeystorePassword string: Password for the private key.
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.
Name string: Display name of provider when linked in admin console.
Priority int: Priority for the provider. Defaults to 0

KeyAlias string: Alias for the private key
KeyPassword string: Password for the private key
Keystore string: Path to keys file on keycloak instance.
KeystorePassword string: Password for the private key.
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.
Name string: Display name of provider when linked in admin console.
Priority int: Priority for the provider. Defaults to 0

keyAlias String: Alias for the private key
keyPassword String: Password for the private key
keystore String: Path to keys file on keycloak instance.
keystorePassword String: Password for the private key.
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.
name String: Display name of provider when linked in admin console.
priority Integer: Priority for the provider. Defaults to 0

keyAlias string: Alias for the private key
keyPassword string: Password for the private key
keystore string: Path to keys file on keycloak instance.
keystorePassword string: Password for the private key.
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.
name string: Display name of provider when linked in admin console.
priority number: Priority for the provider. Defaults to 0

key_alias str: Alias for the private key
key_password str: Password for the private key
keystore str: Path to keys file on keycloak instance.
keystore_password str: Password for the private key.
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.
name str: Display name of provider when linked in admin console.
priority int: Priority for the provider. Defaults to 0

keyAlias String: Alias for the private key
keyPassword String: Password for the private key
keystore String: Path to keys file on keycloak instance.
keystorePassword String: Password for the private key.
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.
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 RealmKeystoreJavaGenerated 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 RealmKeystoreJavaGenerated Resource

Get an existing RealmKeystoreJavaGenerated 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?: RealmKeystoreJavaGeneratedState, opts?: CustomResourceOptions): RealmKeystoreJavaGenerated

@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_alias: Optional[str] = None,
        key_password: Optional[str] = None,
        keystore: Optional[str] = None,
        keystore_password: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        realm_id: Optional[str] = None) -> RealmKeystoreJavaGenerated

func GetRealmKeystoreJavaGenerated(ctx *Context, name string, id IDInput, state *RealmKeystoreJavaGeneratedState, opts ...ResourceOption) (*RealmKeystoreJavaGenerated, error)

public static RealmKeystoreJavaGenerated Get(string name, Input<string> id, RealmKeystoreJavaGeneratedState? state, CustomResourceOptions? opts = null)

public static RealmKeystoreJavaGenerated get(String name, Output<String> id, RealmKeystoreJavaGeneratedState 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.
KeyAlias string: Alias for the private key
KeyPassword string: Password for the private key
Keystore string: Path to keys file on keycloak instance.
KeystorePassword string: Password for the private key.
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.
KeyAlias string: Alias for the private key
KeyPassword string: Password for the private key
Keystore string: Path to keys file on keycloak instance.
KeystorePassword string: Password for the private key.
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.
keyAlias String: Alias for the private key
keyPassword String: Password for the private key
keystore String: Path to keys file on keycloak instance.
keystorePassword String: Password for the private key.
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.
keyAlias string: Alias for the private key
keyPassword string: Password for the private key
keystore string: Path to keys file on keycloak instance.
keystorePassword string: Password for the private key.
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_alias str: Alias for the private key
key_password str: Password for the private key
keystore str: Path to keys file on keycloak instance.
keystore_password str: Password for the private key.
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.
keyAlias String: Alias for the private key
keyPassword String: Password for the private key
keystore String: Path to keys file on keycloak instance.
keystorePassword String: Password for the private key.
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/realmKeystoreJavaGenerated:RealmKeystoreJavaGenerated java_keystore 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.