1. Packages
  2. Keycloak
  3. API Docs
  4. RealmKeystoreEcdsaGenerated
Keycloak v5.2.1 published on Tuesday, Jun 27, 2023 by Pulumi

keycloak.RealmKeystoreEcdsaGenerated

Explore with Pulumi AI

keycloak logo
Keycloak v5.2.1 published on Tuesday, Jun 27, 2023 by Pulumi

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

    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",
        });
    
        var keystoreEcdsaGenerated = new Keycloak.RealmKeystoreEcdsaGenerated("keystoreEcdsaGenerated", new()
        {
            RealmId = realm.Id,
            Enabled = true,
            Active = true,
            Priority = 100,
            EllipticCurveKey = "P-256",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
    	"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"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = keycloak.NewRealmKeystoreEcdsaGenerated(ctx, "keystoreEcdsaGenerated", &keycloak.RealmKeystoreEcdsaGeneratedArgs{
    			RealmId:          realm.ID(),
    			Enabled:          pulumi.Bool(true),
    			Active:           pulumi.Bool(true),
    			Priority:         pulumi.Int(100),
    			EllipticCurveKey: pulumi.String("P-256"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.RealmKeystoreEcdsaGenerated;
    import com.pulumi.keycloak.RealmKeystoreEcdsaGeneratedArgs;
    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 keystoreEcdsaGenerated = new RealmKeystoreEcdsaGenerated("keystoreEcdsaGenerated", RealmKeystoreEcdsaGeneratedArgs.builder()        
                .realmId(realm.id())
                .enabled(true)
                .active(true)
                .priority(100)
                .ellipticCurveKey("P-256")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_keycloak as keycloak
    
    realm = keycloak.Realm("realm", realm="my-realm")
    keystore_ecdsa_generated = keycloak.RealmKeystoreEcdsaGenerated("keystoreEcdsaGenerated",
        realm_id=realm.id,
        enabled=True,
        active=True,
        priority=100,
        elliptic_curve_key="P-256")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as keycloak from "@pulumi/keycloak";
    
    const realm = new keycloak.Realm("realm", {realm: "my-realm"});
    const keystoreEcdsaGenerated = new keycloak.RealmKeystoreEcdsaGenerated("keystoreEcdsaGenerated", {
        realmId: realm.id,
        enabled: true,
        active: true,
        priority: 100,
        ellipticCurveKey: "P-256",
    });
    
    resources:
      realm:
        type: keycloak:Realm
        properties:
          realm: my-realm
      keystoreEcdsaGenerated:
        type: keycloak:RealmKeystoreEcdsaGenerated
        properties:
          realmId: ${realm.id}
          enabled: true
          active: true
          priority: 100
          ellipticCurveKey: P-256
    

    Create RealmKeystoreEcdsaGenerated Resource

    new RealmKeystoreEcdsaGenerated(name: string, args: RealmKeystoreEcdsaGeneratedArgs, opts?: CustomResourceOptions);
    @overload
    def RealmKeystoreEcdsaGenerated(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    active: Optional[bool] = None,
                                    elliptic_curve_key: Optional[str] = None,
                                    enabled: Optional[bool] = None,
                                    name: Optional[str] = None,
                                    priority: Optional[int] = None,
                                    realm_id: Optional[str] = None)
    @overload
    def RealmKeystoreEcdsaGenerated(resource_name: str,
                                    args: RealmKeystoreEcdsaGeneratedArgs,
                                    opts: Optional[ResourceOptions] = None)
    func NewRealmKeystoreEcdsaGenerated(ctx *Context, name string, args RealmKeystoreEcdsaGeneratedArgs, opts ...ResourceOption) (*RealmKeystoreEcdsaGenerated, error)
    public RealmKeystoreEcdsaGenerated(string name, RealmKeystoreEcdsaGeneratedArgs args, CustomResourceOptions? opts = null)
    public RealmKeystoreEcdsaGenerated(String name, RealmKeystoreEcdsaGeneratedArgs args)
    public RealmKeystoreEcdsaGenerated(String name, RealmKeystoreEcdsaGeneratedArgs args, CustomResourceOptions options)
    
    type: keycloak:RealmKeystoreEcdsaGenerated
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args RealmKeystoreEcdsaGeneratedArgs
    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 RealmKeystoreEcdsaGeneratedArgs
    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 RealmKeystoreEcdsaGeneratedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RealmKeystoreEcdsaGeneratedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RealmKeystoreEcdsaGeneratedArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RealmKeystoreEcdsaGenerated 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 RealmKeystoreEcdsaGenerated 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.

    EllipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    RealmId string

    The realm this keystore exists in.

    Active bool

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

    EllipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realmId String

    The realm this keystore exists in.

    active Boolean

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

    ellipticCurveKey String

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realmId string

    The realm this keystore exists in.

    active boolean

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

    ellipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realm_id str

    The realm this keystore exists in.

    active bool

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

    elliptic_curve_key str

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realmId String

    The realm this keystore exists in.

    active Boolean

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

    ellipticCurveKey String

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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 RealmKeystoreEcdsaGenerated 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 RealmKeystoreEcdsaGenerated Resource

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

    EllipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    RealmId string

    The realm this keystore exists in.

    Active bool

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

    EllipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    RealmId string

    The realm this keystore exists in.

    active Boolean

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

    ellipticCurveKey String

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realmId String

    The realm this keystore exists in.

    active boolean

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

    ellipticCurveKey string

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realmId string

    The realm this keystore exists in.

    active bool

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

    elliptic_curve_key str

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    realm_id str

    The realm this keystore exists in.

    active Boolean

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

    ellipticCurveKey String

    Elliptic Curve used in ECDSA. Defaults to P-256.

    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

    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/realmKeystoreEcdsaGenerated:RealmKeystoreEcdsaGenerated keystore_ecdsa_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.

    keycloak logo
    Keycloak v5.2.1 published on Tuesday, Jun 27, 2023 by Pulumi