Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
published on Friday, Nov 6, 2026 by kong
konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
published on Friday, Nov 6, 2026 by kong
IdentityDirectory Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";
const myIdentitydirectory = new konnect.IdentityDirectory("my_identitydirectory", {
allowAllControlPlanes: false,
allowedControlPlanes: ["ae809a12-d526-462e-bd1a-43f66dc49389"],
description: "...my_description...",
forceDestroy: "false",
labels: {
key: "value",
},
managedBy: {
key: "value",
},
name: "...my_name...",
negativeTtlSecs: 600,
ttlSecs: 600,
vaultEnabled: false,
});
import pulumi
import pulumi_konnect as konnect
my_identitydirectory = konnect.IdentityDirectory("my_identitydirectory",
allow_all_control_planes=False,
allowed_control_planes=["ae809a12-d526-462e-bd1a-43f66dc49389"],
description="...my_description...",
force_destroy="false",
labels={
"key": "value",
},
managed_by={
"key": "value",
},
name="...my_name...",
negative_ttl_secs=600,
ttl_secs=600,
vault_enabled=False)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := konnect.NewIdentityDirectory(ctx, "my_identitydirectory", &konnect.IdentityDirectoryArgs{
AllowAllControlPlanes: pulumi.Bool(false),
AllowedControlPlanes: pulumi.StringArray{
pulumi.String("ae809a12-d526-462e-bd1a-43f66dc49389"),
},
Description: pulumi.String("...my_description..."),
ForceDestroy: pulumi.String("false"),
Labels: pulumi.StringMap{
"key": pulumi.String("value"),
},
ManagedBy: pulumi.StringMap{
"key": pulumi.String("value"),
},
Name: pulumi.String("...my_name..."),
NegativeTtlSecs: pulumi.Float64(600),
TtlSecs: pulumi.Float64(600),
VaultEnabled: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;
return await Deployment.RunAsync(() =>
{
var myIdentitydirectory = new Konnect.IdentityDirectory("my_identitydirectory", new()
{
AllowAllControlPlanes = false,
AllowedControlPlanes = new[]
{
"ae809a12-d526-462e-bd1a-43f66dc49389",
},
Description = "...my_description...",
ForceDestroy = "false",
Labels =
{
{ "key", "value" },
},
ManagedBy =
{
{ "key", "value" },
},
Name = "...my_name...",
NegativeTtlSecs = 600,
TtlSecs = 600,
VaultEnabled = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityDirectory;
import com.pulumi.konnect.IdentityDirectoryArgs;
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 myIdentitydirectory = new IdentityDirectory("myIdentitydirectory", IdentityDirectoryArgs.builder()
.allowAllControlPlanes(false)
.allowedControlPlanes("ae809a12-d526-462e-bd1a-43f66dc49389")
.description("...my_description...")
.forceDestroy("false")
.labels(Map.of("key", "value"))
.managedBy(Map.of("key", "value"))
.name("...my_name...")
.negativeTtlSecs(600.0)
.ttlSecs(600.0)
.vaultEnabled(false)
.build());
}
}
resources:
myIdentitydirectory:
type: konnect:IdentityDirectory
name: my_identitydirectory
properties:
allowAllControlPlanes: false
allowedControlPlanes:
- ae809a12-d526-462e-bd1a-43f66dc49389
description: '...my_description...'
forceDestroy: 'false'
labels:
key: value
managedBy:
key: value
name: '...my_name...'
negativeTtlSecs: 600
ttlSecs: 600
vaultEnabled: false
Example coming soon!
Create IdentityDirectory Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IdentityDirectory(name: string, args?: IdentityDirectoryArgs, opts?: CustomResourceOptions);@overload
def IdentityDirectory(resource_name: str,
args: Optional[IdentityDirectoryArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def IdentityDirectory(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_all_control_planes: Optional[bool] = None,
allowed_control_planes: Optional[Sequence[str]] = None,
description: Optional[str] = None,
force_destroy: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
managed_by: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
negative_ttl_secs: Optional[float] = None,
ttl_secs: Optional[float] = None,
vault_enabled: Optional[bool] = None)func NewIdentityDirectory(ctx *Context, name string, args *IdentityDirectoryArgs, opts ...ResourceOption) (*IdentityDirectory, error)public IdentityDirectory(string name, IdentityDirectoryArgs? args = null, CustomResourceOptions? opts = null)
public IdentityDirectory(String name, IdentityDirectoryArgs args)
public IdentityDirectory(String name, IdentityDirectoryArgs args, CustomResourceOptions options)
type: konnect:IdentityDirectory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "konnect_identity_directory" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IdentityDirectoryArgs
- 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 IdentityDirectoryArgs
- 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 IdentityDirectoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdentityDirectoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IdentityDirectoryArgs
- 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 identityDirectoryResource = new Konnect.IdentityDirectory("identityDirectoryResource", new()
{
AllowAllControlPlanes = false,
AllowedControlPlanes = new[]
{
"string",
},
Description = "string",
ForceDestroy = "string",
Labels =
{
{ "string", "string" },
},
ManagedBy =
{
{ "string", "string" },
},
Name = "string",
NegativeTtlSecs = 0.0,
TtlSecs = 0.0,
VaultEnabled = false,
});
example, err := konnect.NewIdentityDirectory(ctx, "identityDirectoryResource", &konnect.IdentityDirectoryArgs{
AllowAllControlPlanes: pulumi.Bool(false),
AllowedControlPlanes: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
ForceDestroy: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
ManagedBy: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
NegativeTtlSecs: pulumi.Float64(0),
TtlSecs: pulumi.Float64(0),
VaultEnabled: pulumi.Bool(false),
})
resource "konnect_identity_directory" "identityDirectoryResource" {
lifecycle {
create_before_destroy = true
}
allow_all_control_planes = false
allowed_control_planes = ["string"]
description = "string"
force_destroy = "string"
labels = {
"string" = "string"
}
managed_by = {
"string" = "string"
}
name = "string"
negative_ttl_secs = 0
ttl_secs = 0
vault_enabled = false
}
var identityDirectoryResource = new IdentityDirectory("identityDirectoryResource", IdentityDirectoryArgs.builder()
.allowAllControlPlanes(false)
.allowedControlPlanes("string")
.description("string")
.forceDestroy("string")
.labels(Map.of("string", "string"))
.managedBy(Map.of("string", "string"))
.name("string")
.negativeTtlSecs(0.0)
.ttlSecs(0.0)
.vaultEnabled(false)
.build());
identity_directory_resource = konnect.IdentityDirectory("identityDirectoryResource",
allow_all_control_planes=False,
allowed_control_planes=["string"],
description="string",
force_destroy="string",
labels={
"string": "string",
},
managed_by={
"string": "string",
},
name="string",
negative_ttl_secs=float(0),
ttl_secs=float(0),
vault_enabled=False)
const identityDirectoryResource = new konnect.IdentityDirectory("identityDirectoryResource", {
allowAllControlPlanes: false,
allowedControlPlanes: ["string"],
description: "string",
forceDestroy: "string",
labels: {
string: "string",
},
managedBy: {
string: "string",
},
name: "string",
negativeTtlSecs: 0,
ttlSecs: 0,
vaultEnabled: false,
});
type: konnect:IdentityDirectory
properties:
allowAllControlPlanes: false
allowedControlPlanes:
- string
description: string
forceDestroy: string
labels:
string: string
managedBy:
string: string
name: string
negativeTtlSecs: 0
ttlSecs: 0
vaultEnabled: false
IdentityDirectory 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 IdentityDirectory resource accepts the following input properties:
- Allow
All boolControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- Allowed
Control List<string>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- Description string
- Optional description providing additional context about the directory's purpose or usage.
- Force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- Labels Dictionary<string, string>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- Managed
By Dictionary<string, string> - Name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- Negative
Ttl doubleSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- Ttl
Secs double - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- Vault
Enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- Allow
All boolControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- Allowed
Control []stringPlanes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- Description string
- Optional description providing additional context about the directory's purpose or usage.
- Force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- Labels map[string]string
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- Managed
By map[string]string - Name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- Negative
Ttl float64Secs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- Ttl
Secs float64 - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- Vault
Enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow_
all_ boolcontrol_ planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed_
control_ list(string)planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- description string
- Optional description providing additional context about the directory's purpose or usage.
- force_
destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels map(string)
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed_
by map(string) - name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative_
ttl_ numbersecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl_
secs number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- vault_
enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All BooleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control List<String>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- description String
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy String - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Map<String,String>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By Map<String,String> - name String
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl DoubleSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs Double - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- vault
Enabled Boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All booleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control string[]Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- description string
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels {[key: string]: string}
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By {[key: string]: string} - name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl numberSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- vault
Enabled boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow_
all_ boolcontrol_ planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed_
control_ Sequence[str]planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- description str
- Optional description providing additional context about the directory's purpose or usage.
- force_
destroy str - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Mapping[str, str]
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed_
by Mapping[str, str] - name str
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative_
ttl_ floatsecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl_
secs float - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- vault_
enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All BooleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control List<String>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- description String
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy String - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Map<String>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By Map<String> - name String
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl NumberSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs Number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- vault
Enabled Boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
Outputs
All input properties are implicitly available as output properties. Additionally, the IdentityDirectory resource produces the following output properties:
- created_
at string - An ISO-8601 timestamp representation of entity creation date.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - An ISO-8601 timestamp representation of entity update date.
- created_
at str - An ISO-8601 timestamp representation of entity creation date.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - An ISO-8601 timestamp representation of entity update date.
Look up Existing IdentityDirectory Resource
Get an existing IdentityDirectory 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?: IdentityDirectoryState, opts?: CustomResourceOptions): IdentityDirectory@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_all_control_planes: Optional[bool] = None,
allowed_control_planes: Optional[Sequence[str]] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
force_destroy: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
managed_by: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
negative_ttl_secs: Optional[float] = None,
ttl_secs: Optional[float] = None,
updated_at: Optional[str] = None,
vault_enabled: Optional[bool] = None) -> IdentityDirectoryfunc GetIdentityDirectory(ctx *Context, name string, id IDInput, state *IdentityDirectoryState, opts ...ResourceOption) (*IdentityDirectory, error)public static IdentityDirectory Get(string name, Input<string> id, IdentityDirectoryState? state, CustomResourceOptions? opts = null)public static IdentityDirectory get(String name, Output<String> id, IdentityDirectoryState state, CustomResourceOptions options)resources: _: type: konnect:IdentityDirectory get: id: ${id}import {
to = konnect_identity_directory.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.
- Allow
All boolControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- Allowed
Control List<string>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Description string
- Optional description providing additional context about the directory's purpose or usage.
- Force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- Labels Dictionary<string, string>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- Managed
By Dictionary<string, string> - Name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- Negative
Ttl doubleSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- Ttl
Secs double - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- Vault
Enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- Allow
All boolControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- Allowed
Control []stringPlanes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Description string
- Optional description providing additional context about the directory's purpose or usage.
- Force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- Labels map[string]string
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- Managed
By map[string]string - Name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- Negative
Ttl float64Secs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- Ttl
Secs float64 - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- Vault
Enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow_
all_ boolcontrol_ planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed_
control_ list(string)planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- created_
at string - An ISO-8601 timestamp representation of entity creation date.
- description string
- Optional description providing additional context about the directory's purpose or usage.
- force_
destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels map(string)
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed_
by map(string) - name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative_
ttl_ numbersecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl_
secs number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- updated_
at string - An ISO-8601 timestamp representation of entity update date.
- vault_
enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All BooleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control List<String>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- description String
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy String - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Map<String,String>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By Map<String,String> - name String
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl DoubleSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs Double - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- updated
At String - An ISO-8601 timestamp representation of entity update date.
- vault
Enabled Boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All booleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control string[]Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- created
At string - An ISO-8601 timestamp representation of entity creation date.
- description string
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy string - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels {[key: string]: string}
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By {[key: string]: string} - name string
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl numberSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- updated
At string - An ISO-8601 timestamp representation of entity update date.
- vault
Enabled boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow_
all_ boolcontrol_ planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed_
control_ Sequence[str]planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- created_
at str - An ISO-8601 timestamp representation of entity creation date.
- description str
- Optional description providing additional context about the directory's purpose or usage.
- force_
destroy str - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Mapping[str, str]
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed_
by Mapping[str, str] - name str
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative_
ttl_ floatsecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl_
secs float - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- updated_
at str - An ISO-8601 timestamp representation of entity update date.
- vault_
enabled bool - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
- allow
All BooleanControl Planes - When set to true, all control planes within the organization can make authentication requests to this directory. This overrides the allowedcontrolplanes list. Defaults to false for security. Default: false
- allowed
Control List<String>Planes - List of control plane IDs authorized to make authentication requests to this directory. Maximum of 32 control planes can be specified. Use allowallcontrol_planes for unrestricted access. Default: []
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- description String
- Optional description providing additional context about the directory's purpose or usage.
- force
Destroy String - If true, delete the specified directory and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server. Default: "false"; must be one of ["true", "false"]
- labels Map<String>
- Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
- managed
By Map<String> - name String
- Human-readable name of the directory, used to identify the organizational boundary. A directory name is unique within the organization.
- negative
Ttl NumberSecs If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory, a
negative_ttl_secsis set. The Gateway will not try to look up the principal in Konnect fornegative_ttl_secsseconds.A principal will be cached for
negative_ttl_secsif it does not exist in the directory, or if the provided credentials are invalid. Maximum is 86400 seconds (24 hours). Default: 600- ttl
Secs Number - The time in seconds that a principal will be cached in memory on a running Gateway if it is successfully authenticated from this directory. Maximum is 86400 seconds (24 hours). Default: 600
- updated
At String - An ISO-8601 timestamp representation of entity update date.
- vault
Enabled Boolean - Set to enabled to enable the Token Vault for this directory. Defaults to disabled when omitted.
Import
In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:
terraform
import {
to = konnect_identity_directory.my_konnect_identity_directory
id = “5f9fd312-a987-4628-b4c5-bb4f4fddd5f7”
}
The pulumi import command can be used, for example:
$ pulumi import konnect:index/identityDirectory:IdentityDirectory my_konnect_identity_directory "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.
konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
published on Friday, Nov 6, 2026 by kong