TargetKeycloak

akeyless 2.0.4, Aug 10 26

Viewing docs for akeyless 2.0.4
published on Monday, Aug 10, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.4
published on Monday, Aug 10, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create TargetKeycloak Resource

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

Constructor syntax

new TargetKeycloak(name: string, args?: TargetKeycloakArgs, opts?: CustomResourceOptions);

@overload
def TargetKeycloak(resource_name: str,
                   args: Optional[TargetKeycloakArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def TargetKeycloak(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   client_id: Optional[str] = None,
                   client_secret: Optional[str] = None,
                   delete_protection: Optional[str] = None,
                   description: Optional[str] = None,
                   keep_prev_version: Optional[str] = None,
                   key: Optional[str] = None,
                   max_versions: Optional[str] = None,
                   name: Optional[str] = None,
                   realm: Optional[str] = None,
                   target_keycloak_id: Optional[str] = None,
                   url: Optional[str] = None)

func NewTargetKeycloak(ctx *Context, name string, args *TargetKeycloakArgs, opts ...ResourceOption) (*TargetKeycloak, error)

public TargetKeycloak(string name, TargetKeycloakArgs? args = null, CustomResourceOptions? opts = null)

public TargetKeycloak(String name, TargetKeycloakArgs args)
public TargetKeycloak(String name, TargetKeycloakArgs args, CustomResourceOptions options)

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

resource "akeyless_target_keycloak" "name" {
    # resource properties
}

Parameters

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

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

name String: The unique name of the resource.
args TargetKeycloakArgs: 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 targetKeycloakResource = new Akeyless.TargetKeycloak("targetKeycloakResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    DeleteProtection = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    Realm = "string",
    TargetKeycloakId = "string",
    Url = "string",
});

example, err := akeyless.NewTargetKeycloak(ctx, "targetKeycloakResource", &akeyless.TargetKeycloakArgs{
	ClientId:         pulumi.String("string"),
	ClientSecret:     pulumi.String("string"),
	DeleteProtection: pulumi.String("string"),
	Description:      pulumi.String("string"),
	KeepPrevVersion:  pulumi.String("string"),
	Key:              pulumi.String("string"),
	MaxVersions:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	Realm:            pulumi.String("string"),
	TargetKeycloakId: pulumi.String("string"),
	Url:              pulumi.String("string"),
})

resource "akeyless_target_keycloak" "targetKeycloakResource" {
  lifecycle {
    create_before_destroy = true
  }
  client_id          = "string"
  client_secret      = "string"
  delete_protection  = "string"
  description        = "string"
  keep_prev_version  = "string"
  key                = "string"
  max_versions       = "string"
  name               = "string"
  realm              = "string"
  target_keycloak_id = "string"
  url                = "string"
}

var targetKeycloakResource = new TargetKeycloak("targetKeycloakResource", TargetKeycloakArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .deleteProtection("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .realm("string")
    .targetKeycloakId("string")
    .url("string")
    .build());

target_keycloak_resource = akeyless.TargetKeycloak("targetKeycloakResource",
    client_id="string",
    client_secret="string",
    delete_protection="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    realm="string",
    target_keycloak_id="string",
    url="string")

const targetKeycloakResource = new akeyless.TargetKeycloak("targetKeycloakResource", {
    clientId: "string",
    clientSecret: "string",
    deleteProtection: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    realm: "string",
    targetKeycloakId: "string",
    url: "string",
});

type: akeyless:TargetKeycloak
properties:
    clientId: string
    clientSecret: string
    deleteProtection: string
    description: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    realm: string
    targetKeycloakId: string
    url: string

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

ClientId string: Keycloak client ID
ClientSecret string: Keycloak client secret
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
Realm string: Keycloak realm
TargetKeycloakId string: The ID of this resource.
Url string: Keycloak URL

ClientId string: Keycloak client ID
ClientSecret string: Keycloak client secret
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
Realm string: Keycloak realm
TargetKeycloakId string: The ID of this resource.
Url string: Keycloak URL

client_id string: Keycloak client ID
client_secret string: Keycloak client secret
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
realm string: Keycloak realm
target_keycloak_id string: The ID of this resource.
url string: Keycloak URL

clientId String: Keycloak client ID
clientSecret String: Keycloak client secret
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
realm String: Keycloak realm
targetKeycloakId String: The ID of this resource.
url String: Keycloak URL

clientId string: Keycloak client ID
clientSecret string: Keycloak client secret
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
realm string: Keycloak realm
targetKeycloakId string: The ID of this resource.
url string: Keycloak URL

client_id str: Keycloak client ID
client_secret str: Keycloak client secret
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
realm str: Keycloak realm
target_keycloak_id str: The ID of this resource.
url str: Keycloak URL

clientId String: Keycloak client ID
clientSecret String: Keycloak client secret
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
realm String: Keycloak realm
targetKeycloakId String: The ID of this resource.
url String: Keycloak URL

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        realm: Optional[str] = None,
        target_keycloak_id: Optional[str] = None,
        url: Optional[str] = None) -> TargetKeycloak

func GetTargetKeycloak(ctx *Context, name string, id IDInput, state *TargetKeycloakState, opts ...ResourceOption) (*TargetKeycloak, error)

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

public static TargetKeycloak get(String name, Output<String> id, TargetKeycloakState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetKeycloak    get:      id: ${id}

import {
  to = akeyless_target_keycloak.example
  id = "${id}"
}

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:

ClientId string: Keycloak client ID
ClientSecret string: Keycloak client secret
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
Realm string: Keycloak realm
TargetKeycloakId string: The ID of this resource.
Url string: Keycloak URL

ClientId string: Keycloak client ID
ClientSecret string: Keycloak client secret
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
Realm string: Keycloak realm
TargetKeycloakId string: The ID of this resource.
Url string: Keycloak URL

client_id string: Keycloak client ID
client_secret string: Keycloak client secret
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
realm string: Keycloak realm
target_keycloak_id string: The ID of this resource.
url string: Keycloak URL

clientId String: Keycloak client ID
clientSecret String: Keycloak client secret
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
realm String: Keycloak realm
targetKeycloakId String: The ID of this resource.
url String: Keycloak URL

clientId string: Keycloak client ID
clientSecret string: Keycloak client secret
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
realm string: Keycloak realm
targetKeycloakId string: The ID of this resource.
url string: Keycloak URL

client_id str: Keycloak client ID
client_secret str: Keycloak client secret
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
realm str: Keycloak realm
target_keycloak_id str: The ID of this resource.
url str: Keycloak URL

clientId String: Keycloak client ID
clientSecret String: Keycloak client secret
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
realm String: Keycloak realm
targetKeycloakId String: The ID of this resource.
url String: Keycloak URL

Package Details

Repository: akeyless akeyless-community/terraform-provider-akeyless
License
Notes: This Pulumi package is based on the akeyless Terraform Provider.

Viewing docs for akeyless 2.0.4
published on Monday, Aug 10, 2026 by akeyless-community

Schema (JSON)

akeyless-community/terraform-provider-akeyless

akeyless.TargetKeycloak

On this page

On this page

Create TargetKeycloak Resource

Constructor syntax

Parameters

Constructor example

TargetKeycloak Resource Properties

Inputs

Outputs

Look up Existing TargetKeycloak Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

akeyless.TargetKeycloak

On this page

On this page

Create TargetKeycloak Resource

Constructor syntax

Parameters

Constructor example

TargetKeycloak Resource Properties

Inputs

Outputs

Look up Existing TargetKeycloak Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.