IdentityPrincipal

konnect 3.28.0, Nov 6 26

Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

Schema (JSON)

kong/terraform-provider-konnect

konnect

Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

Schema (JSON)

kong/terraform-provider-konnect

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myIdentityprincipal = new konnect.IdentityPrincipal("my_identityprincipal", {
    active: true,
    description: "...my_description...",
    directoryId: "7ce7d7f7-55e9-4ce9-a436-233262cc9be9",
    displayName: "...my_display_name...",
    labels: {
        key: "value",
    },
    managedBy: {
        key: "value",
    },
    metadata: "{ \"see\": \"documentation\" }",
    type: "agent",
});

import pulumi
import pulumi_konnect as konnect

my_identityprincipal = konnect.IdentityPrincipal("my_identityprincipal",
    active=True,
    description="...my_description...",
    directory_id="7ce7d7f7-55e9-4ce9-a436-233262cc9be9",
    display_name="...my_display_name...",
    labels={
        "key": "value",
    },
    managed_by={
        "key": "value",
    },
    metadata="{ \"see\": \"documentation\" }",
    type="agent")

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.NewIdentityPrincipal(ctx, "my_identityprincipal", &konnect.IdentityPrincipalArgs{
			Active:      pulumi.Bool(true),
			Description: pulumi.String("...my_description..."),
			DirectoryId: pulumi.String("7ce7d7f7-55e9-4ce9-a436-233262cc9be9"),
			DisplayName: pulumi.String("...my_display_name..."),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			ManagedBy: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Metadata: pulumi.String("{ \"see\": \"documentation\" }"),
			Type:     pulumi.String("agent"),
		})
		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 myIdentityprincipal = new Konnect.IdentityPrincipal("my_identityprincipal", new()
    {
        Active = true,
        Description = "...my_description...",
        DirectoryId = "7ce7d7f7-55e9-4ce9-a436-233262cc9be9",
        DisplayName = "...my_display_name...",
        Labels = 
        {
            { "key", "value" },
        },
        ManagedBy = 
        {
            { "key", "value" },
        },
        Metadata = "{ \"see\": \"documentation\" }",
        Type = "agent",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityPrincipal;
import com.pulumi.konnect.IdentityPrincipalArgs;
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 myIdentityprincipal = new IdentityPrincipal("myIdentityprincipal", IdentityPrincipalArgs.builder()
            .active(true)
            .description("...my_description...")
            .directoryId("7ce7d7f7-55e9-4ce9-a436-233262cc9be9")
            .displayName("...my_display_name...")
            .labels(Map.of("key", "value"))
            .managedBy(Map.of("key", "value"))
            .metadata("{ \"see\": \"documentation\" }")
            .type("agent")
            .build());

    }
}

resources:
  myIdentityprincipal:
    type: konnect:IdentityPrincipal
    name: my_identityprincipal
    properties:
      active: true
      description: '...my_description...'
      directoryId: 7ce7d7f7-55e9-4ce9-a436-233262cc9be9
      displayName: '...my_display_name...'
      labels:
        key: value
      managedBy:
        key: value
      metadata: '{ "see": "documentation" }'
      type: agent

Example coming soon!

Create IdentityPrincipal Resource

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

Constructor syntax

new IdentityPrincipal(name: string, args: IdentityPrincipalArgs, opts?: CustomResourceOptions);

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

@overload
def IdentityPrincipal(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      directory_id: Optional[str] = None,
                      active: Optional[bool] = None,
                      description: Optional[str] = None,
                      display_name: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      managed_by: Optional[Mapping[str, str]] = None,
                      metadata: Optional[str] = None,
                      type: Optional[str] = None)

func NewIdentityPrincipal(ctx *Context, name string, args IdentityPrincipalArgs, opts ...ResourceOption) (*IdentityPrincipal, error)

public IdentityPrincipal(string name, IdentityPrincipalArgs args, CustomResourceOptions? opts = null)

public IdentityPrincipal(String name, IdentityPrincipalArgs args)
public IdentityPrincipal(String name, IdentityPrincipalArgs args, CustomResourceOptions options)

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

resource "konnect_identity_principal" "name" {
    # resource properties
}

Parameters

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

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

name String: The unique name of the resource.
args IdentityPrincipalArgs: 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 identityPrincipalResource = new Konnect.IdentityPrincipal("identityPrincipalResource", new()
{
    DirectoryId = "string",
    Active = false,
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    ManagedBy = 
    {
        { "string", "string" },
    },
    Metadata = "string",
    Type = "string",
});

example, err := konnect.NewIdentityPrincipal(ctx, "identityPrincipalResource", &konnect.IdentityPrincipalArgs{
	DirectoryId: pulumi.String("string"),
	Active:      pulumi.Bool(false),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ManagedBy: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metadata: pulumi.String("string"),
	Type:     pulumi.String("string"),
})

resource "konnect_identity_principal" "identityPrincipalResource" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = "string"
  active       = false
  description  = "string"
  display_name = "string"
  labels = {
    "string" = "string"
  }
  managed_by = {
    "string" = "string"
  }
  metadata = "string"
  type     = "string"
}

var identityPrincipalResource = new IdentityPrincipal("identityPrincipalResource", IdentityPrincipalArgs.builder()
    .directoryId("string")
    .active(false)
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .managedBy(Map.of("string", "string"))
    .metadata("string")
    .type("string")
    .build());

identity_principal_resource = konnect.IdentityPrincipal("identityPrincipalResource",
    directory_id="string",
    active=False,
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    managed_by={
        "string": "string",
    },
    metadata="string",
    type="string")

const identityPrincipalResource = new konnect.IdentityPrincipal("identityPrincipalResource", {
    directoryId: "string",
    active: false,
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    managedBy: {
        string: "string",
    },
    metadata: "string",
    type: "string",
});

type: konnect:IdentityPrincipal
properties:
    active: false
    description: string
    directoryId: string
    displayName: string
    labels:
        string: string
    managedBy:
        string: string
    metadata: string
    type: string

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

DirectoryId string: ID of the directory
Active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
Description string: Optional description providing additional context about the principal's purpose or role.
DisplayName string: Human-readable name of the principal.
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.
ManagedBy Dictionary<string, string>
Metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
Type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

DirectoryId string: ID of the directory
Active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
Description string: Optional description providing additional context about the principal's purpose or role.
DisplayName string: Human-readable name of the principal.
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.
ManagedBy map[string]string
Metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
Type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

directory_id string: ID of the directory
active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
description string: Optional description providing additional context about the principal's purpose or role.
display_name string: Human-readable name of the principal.
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)
metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

directoryId String: ID of the directory
active Boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
description String: Optional description providing additional context about the principal's purpose or role.
displayName String: Human-readable name of the principal.
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.
managedBy Map<String,String>
metadata String: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
type String: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

directoryId string: ID of the directory
active boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
description string: Optional description providing additional context about the principal's purpose or role.
displayName string: Human-readable name of the principal.
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.
managedBy {[key: string]: string}
metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

directory_id str: ID of the directory
active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
description str: Optional description providing additional context about the principal's purpose or role.
display_name str: Human-readable name of the principal.
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]
metadata str: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
type str: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

directoryId String: ID of the directory
active Boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
description String: Optional description providing additional context about the principal's purpose or role.
displayName String: Human-readable name of the principal.
labels Map<String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
managedBy Map<String>
metadata String: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
type String: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityPrincipal resource produces the following output properties:

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Groups List<string>: List of IDs of the groups this principal is a member of.
Id string: The provider-assigned unique ID for this managed resource.
ProvisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Groups []string: List of IDs of the groups this principal is a member of.
Id string: The provider-assigned unique ID for this managed resource.
ProvisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

created_at string: An ISO-8601 timestamp representation of entity creation date.
groups list(string): List of IDs of the groups this principal is a member of.
id string: The provider-assigned unique ID for this managed resource.
provisioned_by string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
updated_at string: An ISO-8601 timestamp representation of entity update date.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
groups List<String>: List of IDs of the groups this principal is a member of.
id String: The provider-assigned unique ID for this managed resource.
provisionedBy String: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
updatedAt String: An ISO-8601 timestamp representation of entity update date.

createdAt string: An ISO-8601 timestamp representation of entity creation date.
groups string[]: List of IDs of the groups this principal is a member of.
id string: The provider-assigned unique ID for this managed resource.
provisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
updatedAt string: An ISO-8601 timestamp representation of entity update date.

created_at str: An ISO-8601 timestamp representation of entity creation date.
groups Sequence[str]: List of IDs of the groups this principal is a member of.
id str: The provider-assigned unique ID for this managed resource.
provisioned_by str: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
updated_at str: An ISO-8601 timestamp representation of entity update date.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
groups List<String>: List of IDs of the groups this principal is a member of.
id String: The provider-assigned unique ID for this managed resource.
provisionedBy String: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
updatedAt String: An ISO-8601 timestamp representation of entity update date.

Look up Existing IdentityPrincipal Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        display_name: Optional[str] = None,
        groups: Optional[Sequence[str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        managed_by: Optional[Mapping[str, str]] = None,
        metadata: Optional[str] = None,
        provisioned_by: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> IdentityPrincipal

func GetIdentityPrincipal(ctx *Context, name string, id IDInput, state *IdentityPrincipalState, opts ...ResourceOption) (*IdentityPrincipal, error)

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

public static IdentityPrincipal get(String name, Output<String> id, IdentityPrincipalState state, CustomResourceOptions options)

resources:  _:    type: konnect:IdentityPrincipal    get:      id: ${id}

import {
  to = konnect_identity_principal.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:

Active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Description string: Optional description providing additional context about the principal's purpose or role.
DirectoryId string: ID of the directory
DisplayName string: Human-readable name of the principal.
Groups List<string>: List of IDs of the groups this principal is a member of.
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.
ManagedBy Dictionary<string, string>
Metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
ProvisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
Type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

Active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Description string: Optional description providing additional context about the principal's purpose or role.
DirectoryId string: ID of the directory
DisplayName string: Human-readable name of the principal.
Groups []string: List of IDs of the groups this principal is a member of.
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.
ManagedBy map[string]string
Metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
ProvisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
Type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
created_at string: An ISO-8601 timestamp representation of entity creation date.
description string: Optional description providing additional context about the principal's purpose or role.
directory_id string: ID of the directory
display_name string: Human-readable name of the principal.
groups list(string): List of IDs of the groups this principal is a member of.
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)
metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
provisioned_by string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
updated_at string: An ISO-8601 timestamp representation of entity update date.

active Boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
createdAt String: An ISO-8601 timestamp representation of entity creation date.
description String: Optional description providing additional context about the principal's purpose or role.
directoryId String: ID of the directory
displayName String: Human-readable name of the principal.
groups List<String>: List of IDs of the groups this principal is a member of.
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.
managedBy Map<String,String>
metadata String: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
provisionedBy String: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
type String: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
updatedAt String: An ISO-8601 timestamp representation of entity update date.

active boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
createdAt string: An ISO-8601 timestamp representation of entity creation date.
description string: Optional description providing additional context about the principal's purpose or role.
directoryId string: ID of the directory
displayName string: Human-readable name of the principal.
groups string[]: List of IDs of the groups this principal is a member of.
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.
managedBy {[key: string]: string}
metadata string: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
provisionedBy string: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
type string: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
updatedAt string: An ISO-8601 timestamp representation of entity update date.

active bool: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
created_at str: An ISO-8601 timestamp representation of entity creation date.
description str: Optional description providing additional context about the principal's purpose or role.
directory_id str: ID of the directory
display_name str: Human-readable name of the principal.
groups Sequence[str]: List of IDs of the groups this principal is a member of.
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]
metadata str: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
provisioned_by str: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
type str: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
updated_at str: An ISO-8601 timestamp representation of entity update date.

active Boolean: Whether the principal is active. Inactive principals are treated as nonexistent when authenticating. Defaults to true on create; omitting it on update or replace keeps the current value. Setting it to false sets provisioned_by to konnect_user. Principals provisioned by the developer portal cannot be deactivated.
createdAt String: An ISO-8601 timestamp representation of entity creation date.
description String: Optional description providing additional context about the principal's purpose or role.
directoryId String: ID of the directory
displayName String: Human-readable name of the principal.
groups List<String>: List of IDs of the groups this principal is a member of.
labels Map<String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
managedBy Map<String>
metadata String: A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
provisionedBy String: Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
type String: Classifies the kind of principal. agent is a deployed AI agent, user is a human in the organization. When omitted or null, the principal is not classified. possible known values include one of ["agent", "user"]
updatedAt String: An ISO-8601 timestamp representation of entity update date.

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_principal.my_konnect_identity_principal

id = jsonencode({

directory_id = "..."

id           = "..."

})

}

The pulumi import command can be used, for example:

$ pulumi import konnect:index/identityPrincipal:IdentityPrincipal my_konnect_identity_principal '{"directory_id": "...", "id": "..."}'

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 konnect Terraform Provider.

konnect

Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

Schema (JSON)

kong/terraform-provider-konnect

konnect.IdentityPrincipal

On this page

On this page

Example Usage

Create IdentityPrincipal Resource

Constructor syntax

Parameters

Constructor example

IdentityPrincipal Resource Properties

Inputs

Outputs

Look up Existing IdentityPrincipal Resource

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

konnect.IdentityPrincipal

On this page

On this page

Example Usage

Create IdentityPrincipal Resource

Constructor syntax

Parameters

Constructor example

IdentityPrincipal Resource Properties

Inputs

Outputs

Look up Existing IdentityPrincipal Resource

Import

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.