1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. IdentityPrincipalIdentity
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

    IdentityPrincipalIdentity Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myIdentityprincipalidentity = new konnect.IdentityPrincipalIdentity("my_identityprincipalidentity", {
        authServerClient: {
            authServerId: "764ebd98-5bf8-4c1c-862c-0c115cc3fd21",
            clientId: "...my_client_id...",
            labels: {
                key: "value",
            },
            managedBy: {
                key: "value",
            },
        },
        controlPlaneConsumer: {
            consumerId: "...my_consumer_id...",
            controlPlaneId: "...my_control_plane_id...",
            labels: {
                key: "value",
            },
            managedBy: {
                key: "value",
            },
            workspaceId: "...my_workspace_id...",
        },
        custom: {
            key: "...my_key...",
            labels: {
                key: "value",
            },
            managedBy: {
                key: "value",
            },
            value: "...my_value...",
        },
        directoryId: "b6e820c3-0070-4ea2-ad6f-3b44c07d409d",
        oidc: {
            claim: {
                name: "...my_name...",
                value: "...my_value...",
            },
            issuer: "...my_issuer...",
            labels: {
                key: "value",
            },
            managedBy: {
                key: "value",
            },
        },
        principalId: "b63e8652-e7d8-41ba-ba07-d093efe7352c",
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_identityprincipalidentity = konnect.IdentityPrincipalIdentity("my_identityprincipalidentity",
        auth_server_client={
            "auth_server_id": "764ebd98-5bf8-4c1c-862c-0c115cc3fd21",
            "client_id": "...my_client_id...",
            "labels": {
                "key": "value",
            },
            "managed_by": {
                "key": "value",
            },
        },
        control_plane_consumer={
            "consumer_id": "...my_consumer_id...",
            "control_plane_id": "...my_control_plane_id...",
            "labels": {
                "key": "value",
            },
            "managed_by": {
                "key": "value",
            },
            "workspace_id": "...my_workspace_id...",
        },
        custom={
            "key": "...my_key...",
            "labels": {
                "key": "value",
            },
            "managed_by": {
                "key": "value",
            },
            "value": "...my_value...",
        },
        directory_id="b6e820c3-0070-4ea2-ad6f-3b44c07d409d",
        oidc={
            "claim": {
                "name": "...my_name...",
                "value": "...my_value...",
            },
            "issuer": "...my_issuer...",
            "labels": {
                "key": "value",
            },
            "managed_by": {
                "key": "value",
            },
        },
        principal_id="b63e8652-e7d8-41ba-ba07-d093efe7352c")
    
    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.NewIdentityPrincipalIdentity(ctx, "my_identityprincipalidentity", &konnect.IdentityPrincipalIdentityArgs{
    			AuthServerClient: &konnect.IdentityPrincipalIdentityAuthServerClientArgs{
    				AuthServerId: pulumi.String("764ebd98-5bf8-4c1c-862c-0c115cc3fd21"),
    				ClientId:     pulumi.String("...my_client_id..."),
    				Labels: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				ManagedBy: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    			},
    			ControlPlaneConsumer: &konnect.IdentityPrincipalIdentityControlPlaneConsumerArgs{
    				ConsumerId:     pulumi.String("...my_consumer_id..."),
    				ControlPlaneId: pulumi.String("...my_control_plane_id..."),
    				Labels: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				ManagedBy: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				WorkspaceId: pulumi.String("...my_workspace_id..."),
    			},
    			Custom: &konnect.IdentityPrincipalIdentityCustomArgs{
    				Key: pulumi.String("...my_key..."),
    				Labels: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				ManagedBy: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				Value: pulumi.String("...my_value..."),
    			},
    			DirectoryId: pulumi.String("b6e820c3-0070-4ea2-ad6f-3b44c07d409d"),
    			Oidc: &konnect.IdentityPrincipalIdentityOidcArgs{
    				Claim: &konnect.IdentityPrincipalIdentityOidcClaimArgs{
    					Name:  pulumi.String("...my_name..."),
    					Value: pulumi.String("...my_value..."),
    				},
    				Issuer: pulumi.String("...my_issuer..."),
    				Labels: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    				ManagedBy: pulumi.StringMap{
    					"key": pulumi.String("value"),
    				},
    			},
    			PrincipalId: pulumi.String("b63e8652-e7d8-41ba-ba07-d093efe7352c"),
    		})
    		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 myIdentityprincipalidentity = new Konnect.IdentityPrincipalIdentity("my_identityprincipalidentity", new()
        {
            AuthServerClient = new Konnect.Inputs.IdentityPrincipalIdentityAuthServerClientArgs
            {
                AuthServerId = "764ebd98-5bf8-4c1c-862c-0c115cc3fd21",
                ClientId = "...my_client_id...",
                Labels = 
                {
                    { "key", "value" },
                },
                ManagedBy = 
                {
                    { "key", "value" },
                },
            },
            ControlPlaneConsumer = new Konnect.Inputs.IdentityPrincipalIdentityControlPlaneConsumerArgs
            {
                ConsumerId = "...my_consumer_id...",
                ControlPlaneId = "...my_control_plane_id...",
                Labels = 
                {
                    { "key", "value" },
                },
                ManagedBy = 
                {
                    { "key", "value" },
                },
                WorkspaceId = "...my_workspace_id...",
            },
            Custom = new Konnect.Inputs.IdentityPrincipalIdentityCustomArgs
            {
                Key = "...my_key...",
                Labels = 
                {
                    { "key", "value" },
                },
                ManagedBy = 
                {
                    { "key", "value" },
                },
                Value = "...my_value...",
            },
            DirectoryId = "b6e820c3-0070-4ea2-ad6f-3b44c07d409d",
            Oidc = new Konnect.Inputs.IdentityPrincipalIdentityOidcArgs
            {
                Claim = new Konnect.Inputs.IdentityPrincipalIdentityOidcClaimArgs
                {
                    Name = "...my_name...",
                    Value = "...my_value...",
                },
                Issuer = "...my_issuer...",
                Labels = 
                {
                    { "key", "value" },
                },
                ManagedBy = 
                {
                    { "key", "value" },
                },
            },
            PrincipalId = "b63e8652-e7d8-41ba-ba07-d093efe7352c",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.IdentityPrincipalIdentity;
    import com.pulumi.konnect.IdentityPrincipalIdentityArgs;
    import com.pulumi.konnect.inputs.IdentityPrincipalIdentityAuthServerClientArgs;
    import com.pulumi.konnect.inputs.IdentityPrincipalIdentityControlPlaneConsumerArgs;
    import com.pulumi.konnect.inputs.IdentityPrincipalIdentityCustomArgs;
    import com.pulumi.konnect.inputs.IdentityPrincipalIdentityOidcArgs;
    import com.pulumi.konnect.inputs.IdentityPrincipalIdentityOidcClaimArgs;
    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 myIdentityprincipalidentity = new IdentityPrincipalIdentity("myIdentityprincipalidentity", IdentityPrincipalIdentityArgs.builder()
                .authServerClient(IdentityPrincipalIdentityAuthServerClientArgs.builder()
                    .authServerId("764ebd98-5bf8-4c1c-862c-0c115cc3fd21")
                    .clientId("...my_client_id...")
                    .labels(Map.of("key", "value"))
                    .managedBy(Map.of("key", "value"))
                    .build())
                .controlPlaneConsumer(IdentityPrincipalIdentityControlPlaneConsumerArgs.builder()
                    .consumerId("...my_consumer_id...")
                    .controlPlaneId("...my_control_plane_id...")
                    .labels(Map.of("key", "value"))
                    .managedBy(Map.of("key", "value"))
                    .workspaceId("...my_workspace_id...")
                    .build())
                .custom(IdentityPrincipalIdentityCustomArgs.builder()
                    .key("...my_key...")
                    .labels(Map.of("key", "value"))
                    .managedBy(Map.of("key", "value"))
                    .value("...my_value...")
                    .build())
                .directoryId("b6e820c3-0070-4ea2-ad6f-3b44c07d409d")
                .oidc(IdentityPrincipalIdentityOidcArgs.builder()
                    .claim(IdentityPrincipalIdentityOidcClaimArgs.builder()
                        .name("...my_name...")
                        .value("...my_value...")
                        .build())
                    .issuer("...my_issuer...")
                    .labels(Map.of("key", "value"))
                    .managedBy(Map.of("key", "value"))
                    .build())
                .principalId("b63e8652-e7d8-41ba-ba07-d093efe7352c")
                .build());
    
        }
    }
    
    resources:
      myIdentityprincipalidentity:
        type: konnect:IdentityPrincipalIdentity
        name: my_identityprincipalidentity
        properties:
          authServerClient:
            authServerId: 764ebd98-5bf8-4c1c-862c-0c115cc3fd21
            clientId: '...my_client_id...'
            labels:
              key: value
            managedBy:
              key: value
          controlPlaneConsumer:
            consumerId: '...my_consumer_id...'
            controlPlaneId: '...my_control_plane_id...'
            labels:
              key: value
            managedBy:
              key: value
            workspaceId: '...my_workspace_id...'
          custom:
            key: '...my_key...'
            labels:
              key: value
            managedBy:
              key: value
            value: '...my_value...'
          directoryId: b6e820c3-0070-4ea2-ad6f-3b44c07d409d
          oidc:
            claim:
              name: '...my_name...'
              value: '...my_value...'
            issuer: '...my_issuer...'
            labels:
              key: value
            managedBy:
              key: value
          principalId: b63e8652-e7d8-41ba-ba07-d093efe7352c
    
    Example coming soon!
    

    Create IdentityPrincipalIdentity Resource

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

    Constructor syntax

    new IdentityPrincipalIdentity(name: string, args: IdentityPrincipalIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def IdentityPrincipalIdentity(resource_name: str,
                                  args: IdentityPrincipalIdentityArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdentityPrincipalIdentity(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  directory_id: Optional[str] = None,
                                  principal_id: Optional[str] = None,
                                  auth_server_client: Optional[IdentityPrincipalIdentityAuthServerClientArgs] = None,
                                  control_plane_consumer: Optional[IdentityPrincipalIdentityControlPlaneConsumerArgs] = None,
                                  custom: Optional[IdentityPrincipalIdentityCustomArgs] = None,
                                  oidc: Optional[IdentityPrincipalIdentityOidcArgs] = None)
    func NewIdentityPrincipalIdentity(ctx *Context, name string, args IdentityPrincipalIdentityArgs, opts ...ResourceOption) (*IdentityPrincipalIdentity, error)
    public IdentityPrincipalIdentity(string name, IdentityPrincipalIdentityArgs args, CustomResourceOptions? opts = null)
    public IdentityPrincipalIdentity(String name, IdentityPrincipalIdentityArgs args)
    public IdentityPrincipalIdentity(String name, IdentityPrincipalIdentityArgs args, CustomResourceOptions options)
    
    type: konnect:IdentityPrincipalIdentity
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "konnect_identity_principal_identity" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IdentityPrincipalIdentityArgs
    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 IdentityPrincipalIdentityArgs
    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 IdentityPrincipalIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityPrincipalIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityPrincipalIdentityArgs
    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 identityPrincipalIdentityResource = new Konnect.IdentityPrincipalIdentity("identityPrincipalIdentityResource", new()
    {
        DirectoryId = "string",
        PrincipalId = "string",
        AuthServerClient = new Konnect.Inputs.IdentityPrincipalIdentityAuthServerClientArgs
        {
            AuthServerId = "string",
            ClientId = "string",
            CreatedAt = "string",
            Id = "string",
            Labels = 
            {
                { "string", "string" },
            },
            ManagedBy = 
            {
                { "string", "string" },
            },
            UpdatedAt = "string",
        },
        ControlPlaneConsumer = new Konnect.Inputs.IdentityPrincipalIdentityControlPlaneConsumerArgs
        {
            ConsumerId = "string",
            ControlPlaneId = "string",
            ControlPlaneType = "string",
            CreatedAt = "string",
            Id = "string",
            Labels = 
            {
                { "string", "string" },
            },
            ManagedBy = 
            {
                { "string", "string" },
            },
            UpdatedAt = "string",
            WorkspaceId = "string",
        },
        Custom = new Konnect.Inputs.IdentityPrincipalIdentityCustomArgs
        {
            CreatedAt = "string",
            Id = "string",
            Key = "string",
            Labels = 
            {
                { "string", "string" },
            },
            ManagedBy = 
            {
                { "string", "string" },
            },
            UpdatedAt = "string",
            Value = "string",
        },
        Oidc = new Konnect.Inputs.IdentityPrincipalIdentityOidcArgs
        {
            Claim = new Konnect.Inputs.IdentityPrincipalIdentityOidcClaimArgs
            {
                Name = "string",
                Value = "string",
            },
            CreatedAt = "string",
            Id = "string",
            Issuer = "string",
            Labels = 
            {
                { "string", "string" },
            },
            ManagedBy = 
            {
                { "string", "string" },
            },
            UpdatedAt = "string",
        },
    });
    
    example, err := konnect.NewIdentityPrincipalIdentity(ctx, "identityPrincipalIdentityResource", &konnect.IdentityPrincipalIdentityArgs{
    	DirectoryId: pulumi.String("string"),
    	PrincipalId: pulumi.String("string"),
    	AuthServerClient: &konnect.IdentityPrincipalIdentityAuthServerClientArgs{
    		AuthServerId: pulumi.String("string"),
    		ClientId:     pulumi.String("string"),
    		CreatedAt:    pulumi.String("string"),
    		Id:           pulumi.String("string"),
    		Labels: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		ManagedBy: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		UpdatedAt: pulumi.String("string"),
    	},
    	ControlPlaneConsumer: &konnect.IdentityPrincipalIdentityControlPlaneConsumerArgs{
    		ConsumerId:       pulumi.String("string"),
    		ControlPlaneId:   pulumi.String("string"),
    		ControlPlaneType: pulumi.String("string"),
    		CreatedAt:        pulumi.String("string"),
    		Id:               pulumi.String("string"),
    		Labels: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		ManagedBy: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		UpdatedAt:   pulumi.String("string"),
    		WorkspaceId: pulumi.String("string"),
    	},
    	Custom: &konnect.IdentityPrincipalIdentityCustomArgs{
    		CreatedAt: pulumi.String("string"),
    		Id:        pulumi.String("string"),
    		Key:       pulumi.String("string"),
    		Labels: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		ManagedBy: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		UpdatedAt: pulumi.String("string"),
    		Value:     pulumi.String("string"),
    	},
    	Oidc: &konnect.IdentityPrincipalIdentityOidcArgs{
    		Claim: &konnect.IdentityPrincipalIdentityOidcClaimArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    		CreatedAt: pulumi.String("string"),
    		Id:        pulumi.String("string"),
    		Issuer:    pulumi.String("string"),
    		Labels: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		ManagedBy: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		UpdatedAt: pulumi.String("string"),
    	},
    })
    
    resource "konnect_identity_principal_identity" "identityPrincipalIdentityResource" {
      lifecycle {
        create_before_destroy = true
      }
      directory_id = "string"
      principal_id = "string"
      auth_server_client = {
        auth_server_id = "string"
        client_id      = "string"
        created_at     = "string"
        id             = "string"
        labels = {
          "string" = "string"
        }
        managed_by = {
          "string" = "string"
        }
        updated_at = "string"
      }
      control_plane_consumer = {
        consumer_id        = "string"
        control_plane_id   = "string"
        control_plane_type = "string"
        created_at         = "string"
        id                 = "string"
        labels = {
          "string" = "string"
        }
        managed_by = {
          "string" = "string"
        }
        updated_at   = "string"
        workspace_id = "string"
      }
      custom = {
        created_at = "string"
        id         = "string"
        key        = "string"
        labels = {
          "string" = "string"
        }
        managed_by = {
          "string" = "string"
        }
        updated_at = "string"
        value      = "string"
      }
      oidc = {
        claim = {
          name  = "string"
          value = "string"
        }
        created_at = "string"
        id         = "string"
        issuer     = "string"
        labels = {
          "string" = "string"
        }
        managed_by = {
          "string" = "string"
        }
        updated_at = "string"
      }
    }
    
    var identityPrincipalIdentityResource = new IdentityPrincipalIdentity("identityPrincipalIdentityResource", IdentityPrincipalIdentityArgs.builder()
        .directoryId("string")
        .principalId("string")
        .authServerClient(IdentityPrincipalIdentityAuthServerClientArgs.builder()
            .authServerId("string")
            .clientId("string")
            .createdAt("string")
            .id("string")
            .labels(Map.of("string", "string"))
            .managedBy(Map.of("string", "string"))
            .updatedAt("string")
            .build())
        .controlPlaneConsumer(IdentityPrincipalIdentityControlPlaneConsumerArgs.builder()
            .consumerId("string")
            .controlPlaneId("string")
            .controlPlaneType("string")
            .createdAt("string")
            .id("string")
            .labels(Map.of("string", "string"))
            .managedBy(Map.of("string", "string"))
            .updatedAt("string")
            .workspaceId("string")
            .build())
        .custom(IdentityPrincipalIdentityCustomArgs.builder()
            .createdAt("string")
            .id("string")
            .key("string")
            .labels(Map.of("string", "string"))
            .managedBy(Map.of("string", "string"))
            .updatedAt("string")
            .value("string")
            .build())
        .oidc(IdentityPrincipalIdentityOidcArgs.builder()
            .claim(IdentityPrincipalIdentityOidcClaimArgs.builder()
                .name("string")
                .value("string")
                .build())
            .createdAt("string")
            .id("string")
            .issuer("string")
            .labels(Map.of("string", "string"))
            .managedBy(Map.of("string", "string"))
            .updatedAt("string")
            .build())
        .build());
    
    identity_principal_identity_resource = konnect.IdentityPrincipalIdentity("identityPrincipalIdentityResource",
        directory_id="string",
        principal_id="string",
        auth_server_client={
            "auth_server_id": "string",
            "client_id": "string",
            "created_at": "string",
            "id": "string",
            "labels": {
                "string": "string",
            },
            "managed_by": {
                "string": "string",
            },
            "updated_at": "string",
        },
        control_plane_consumer={
            "consumer_id": "string",
            "control_plane_id": "string",
            "control_plane_type": "string",
            "created_at": "string",
            "id": "string",
            "labels": {
                "string": "string",
            },
            "managed_by": {
                "string": "string",
            },
            "updated_at": "string",
            "workspace_id": "string",
        },
        custom={
            "created_at": "string",
            "id": "string",
            "key": "string",
            "labels": {
                "string": "string",
            },
            "managed_by": {
                "string": "string",
            },
            "updated_at": "string",
            "value": "string",
        },
        oidc={
            "claim": {
                "name": "string",
                "value": "string",
            },
            "created_at": "string",
            "id": "string",
            "issuer": "string",
            "labels": {
                "string": "string",
            },
            "managed_by": {
                "string": "string",
            },
            "updated_at": "string",
        })
    
    const identityPrincipalIdentityResource = new konnect.IdentityPrincipalIdentity("identityPrincipalIdentityResource", {
        directoryId: "string",
        principalId: "string",
        authServerClient: {
            authServerId: "string",
            clientId: "string",
            createdAt: "string",
            id: "string",
            labels: {
                string: "string",
            },
            managedBy: {
                string: "string",
            },
            updatedAt: "string",
        },
        controlPlaneConsumer: {
            consumerId: "string",
            controlPlaneId: "string",
            controlPlaneType: "string",
            createdAt: "string",
            id: "string",
            labels: {
                string: "string",
            },
            managedBy: {
                string: "string",
            },
            updatedAt: "string",
            workspaceId: "string",
        },
        custom: {
            createdAt: "string",
            id: "string",
            key: "string",
            labels: {
                string: "string",
            },
            managedBy: {
                string: "string",
            },
            updatedAt: "string",
            value: "string",
        },
        oidc: {
            claim: {
                name: "string",
                value: "string",
            },
            createdAt: "string",
            id: "string",
            issuer: "string",
            labels: {
                string: "string",
            },
            managedBy: {
                string: "string",
            },
            updatedAt: "string",
        },
    });
    
    type: konnect:IdentityPrincipalIdentity
    properties:
        authServerClient:
            authServerId: string
            clientId: string
            createdAt: string
            id: string
            labels:
                string: string
            managedBy:
                string: string
            updatedAt: string
        controlPlaneConsumer:
            consumerId: string
            controlPlaneId: string
            controlPlaneType: string
            createdAt: string
            id: string
            labels:
                string: string
            managedBy:
                string: string
            updatedAt: string
            workspaceId: string
        custom:
            createdAt: string
            id: string
            key: string
            labels:
                string: string
            managedBy:
                string: string
            updatedAt: string
            value: string
        directoryId: string
        oidc:
            claim:
                name: string
                value: string
            createdAt: string
            id: string
            issuer: string
            labels:
                string: string
            managedBy:
                string: string
            updatedAt: string
        principalId: string
    

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

    directory_id string
    ID of the directory
    principal_id string
    Unique identifier of the principal (UUID format)
    auth_server_client object
    control_plane_consumer object
    custom object
    oidc object
    directoryId String
    ID of the directory
    principalId String
    Unique identifier of the principal (UUID format)
    authServerClient Property Map
    controlPlaneConsumer Property Map
    custom Property Map
    oidc Property Map

    Outputs

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

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    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.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt 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.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing IdentityPrincipalIdentity Resource

    Get an existing IdentityPrincipalIdentity 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?: IdentityPrincipalIdentityState, opts?: CustomResourceOptions): IdentityPrincipalIdentity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_server_client: Optional[IdentityPrincipalIdentityAuthServerClientArgs] = None,
            control_plane_consumer: Optional[IdentityPrincipalIdentityControlPlaneConsumerArgs] = None,
            created_at: Optional[str] = None,
            custom: Optional[IdentityPrincipalIdentityCustomArgs] = None,
            directory_id: Optional[str] = None,
            oidc: Optional[IdentityPrincipalIdentityOidcArgs] = None,
            principal_id: Optional[str] = None,
            updated_at: Optional[str] = None) -> IdentityPrincipalIdentity
    func GetIdentityPrincipalIdentity(ctx *Context, name string, id IDInput, state *IdentityPrincipalIdentityState, opts ...ResourceOption) (*IdentityPrincipalIdentity, error)
    public static IdentityPrincipalIdentity Get(string name, Input<string> id, IdentityPrincipalIdentityState? state, CustomResourceOptions? opts = null)
    public static IdentityPrincipalIdentity get(String name, Output<String> id, IdentityPrincipalIdentityState state, CustomResourceOptions options)
    resources:  _:    type: konnect:IdentityPrincipalIdentity    get:      id: ${id}
    import {
      to = konnect_identity_principal_identity.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:
    AuthServerClient IdentityPrincipalIdentityAuthServerClient
    ControlPlaneConsumer IdentityPrincipalIdentityControlPlaneConsumer
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Custom IdentityPrincipalIdentityCustom
    DirectoryId string
    ID of the directory
    Oidc IdentityPrincipalIdentityOidc
    PrincipalId string
    Unique identifier of the principal (UUID format)
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    AuthServerClient IdentityPrincipalIdentityAuthServerClientArgs
    ControlPlaneConsumer IdentityPrincipalIdentityControlPlaneConsumerArgs
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Custom IdentityPrincipalIdentityCustomArgs
    DirectoryId string
    ID of the directory
    Oidc IdentityPrincipalIdentityOidcArgs
    PrincipalId string
    Unique identifier of the principal (UUID format)
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    auth_server_client object
    control_plane_consumer object
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    custom object
    directory_id string
    ID of the directory
    oidc object
    principal_id string
    Unique identifier of the principal (UUID format)
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    authServerClient IdentityPrincipalIdentityAuthServerClient
    controlPlaneConsumer IdentityPrincipalIdentityControlPlaneConsumer
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    custom IdentityPrincipalIdentityCustom
    directoryId String
    ID of the directory
    oidc IdentityPrincipalIdentityOidc
    principalId String
    Unique identifier of the principal (UUID format)
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authServerClient IdentityPrincipalIdentityAuthServerClient
    controlPlaneConsumer IdentityPrincipalIdentityControlPlaneConsumer
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    custom IdentityPrincipalIdentityCustom
    directoryId string
    ID of the directory
    oidc IdentityPrincipalIdentityOidc
    principalId string
    Unique identifier of the principal (UUID format)
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    auth_server_client IdentityPrincipalIdentityAuthServerClientArgs
    control_plane_consumer IdentityPrincipalIdentityControlPlaneConsumerArgs
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    custom IdentityPrincipalIdentityCustomArgs
    directory_id str
    ID of the directory
    oidc IdentityPrincipalIdentityOidcArgs
    principal_id str
    Unique identifier of the principal (UUID format)
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authServerClient Property Map
    controlPlaneConsumer Property Map
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    custom Property Map
    directoryId String
    ID of the directory
    oidc Property Map
    principalId String
    Unique identifier of the principal (UUID format)
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    IdentityPrincipalIdentityAuthServerClient, IdentityPrincipalIdentityAuthServerClientArgs

    AuthServerId string
    Not Null
    ClientId string
    Not Null
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    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>
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    AuthServerId string
    Not Null
    ClientId string
    Not Null
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    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
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    auth_server_id string
    Not Null
    client_id string
    Not Null
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    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)
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    authServerId String
    Not Null
    clientId String
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authServerId string
    Not Null
    clientId string
    Not Null
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    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}
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    auth_server_id str
    Not Null
    client_id str
    Not Null
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    Contains a unique identifier used for this resource.
    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]
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authServerId String
    Not Null
    clientId String
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    IdentityPrincipalIdentityControlPlaneConsumer, IdentityPrincipalIdentityControlPlaneConsumerArgs

    ConsumerId string
    Not Null
    ControlPlaneId string
    Not Null
    ControlPlaneType string
    The kind of control plane the linked consumer was found in.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    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>
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    WorkspaceId string
    ConsumerId string
    Not Null
    ControlPlaneId string
    Not Null
    ControlPlaneType string
    The kind of control plane the linked consumer was found in.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    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
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    WorkspaceId string
    consumer_id string
    Not Null
    control_plane_id string
    Not Null
    control_plane_type string
    The kind of control plane the linked consumer was found in.
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    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)
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    workspace_id string
    consumerId String
    Not Null
    controlPlaneId String
    Not Null
    controlPlaneType String
    The kind of control plane the linked consumer was found in.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    workspaceId String
    consumerId string
    Not Null
    controlPlaneId string
    Not Null
    controlPlaneType string
    The kind of control plane the linked consumer was found in.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    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}
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    workspaceId string
    consumer_id str
    Not Null
    control_plane_id str
    Not Null
    control_plane_type str
    The kind of control plane the linked consumer was found in.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    Contains a unique identifier used for this resource.
    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]
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    workspace_id str
    consumerId String
    Not Null
    controlPlaneId String
    Not Null
    controlPlaneType String
    The kind of control plane the linked consumer was found in.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    workspaceId String

    IdentityPrincipalIdentityCustom, IdentityPrincipalIdentityCustomArgs

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Key string
    Not Null
    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>
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Value string
    Not Null
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Key string
    Not Null
    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
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Value string
    Not Null
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    key string
    Not Null
    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)
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    value string
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    key String
    Not Null
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    value String
    Not Null
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    key string
    Not Null
    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}
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    value string
    Not Null
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    Contains a unique identifier used for this resource.
    key str
    Not Null
    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]
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    value str
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    key String
    Not Null
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    value String
    Not Null

    IdentityPrincipalIdentityOidc, IdentityPrincipalIdentityOidcArgs

    Claim IdentityPrincipalIdentityOidcClaim
    Not Null
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Issuer string
    Not Null
    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>
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Claim IdentityPrincipalIdentityOidcClaim
    Not Null
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Issuer string
    Not Null
    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
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    claim object
    Not Null
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    issuer string
    Not Null
    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)
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    claim IdentityPrincipalIdentityOidcClaim
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    issuer String
    Not Null
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    claim IdentityPrincipalIdentityOidcClaim
    Not Null
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    issuer string
    Not Null
    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}
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    claim IdentityPrincipalIdentityOidcClaim
    Not Null
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    Contains a unique identifier used for this resource.
    issuer str
    Not Null
    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]
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    claim Property Map
    Not Null
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    issuer String
    Not Null
    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>
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    IdentityPrincipalIdentityOidcClaim, IdentityPrincipalIdentityOidcClaimArgs

    Name string
    Not Null
    Value string
    Not Null
    Name string
    Not Null
    Value string
    Not Null
    name string
    Not Null
    value string
    Not Null
    name String
    Not Null
    value String
    Not Null
    name string
    Not Null
    value string
    Not Null
    name str
    Not Null
    value str
    Not Null
    name String
    Not Null
    value String
    Not Null

    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_identity.my_konnect_identity_principal_identity

    id = jsonencode({

    directory_id = "..."
    
    id           = "..."
    
    principal_id = "..."
    

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/identityPrincipalIdentity:IdentityPrincipalIdentity my_konnect_identity_principal_identity '{"directory_id": "...", "id": "...", "principal_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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial