1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. PortalIdentityProvider
Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong

    PortalIdentityProvider Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myPortalidentityprovider = new konnect.PortalIdentityProvider("my_portalidentityprovider", {
        config: {
            oidcIdentityProviderConfig: {
                claimMappings: {
                    email: "email",
                    groups: "groups",
                    name: "name",
                },
                clientId: "YOUR_CLIENT_ID",
                clientSecret: "YOUR_CLIENT_SECRET",
                issuerUrl: "https://konghq.okta.com/oauth2/default",
                scopes: ["..."],
            },
        },
        enabled: true,
        portalId: "f32d905a-ed33-46a3-a093-d8f536af9a8a",
        type: "oidc",
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_portalidentityprovider = konnect.PortalIdentityProvider("my_portalidentityprovider",
        config={
            "oidc_identity_provider_config": {
                "claim_mappings": {
                    "email": "email",
                    "groups": "groups",
                    "name": "name",
                },
                "client_id": "YOUR_CLIENT_ID",
                "client_secret": "YOUR_CLIENT_SECRET",
                "issuer_url": "https://konghq.okta.com/oauth2/default",
                "scopes": ["..."],
            },
        },
        enabled=True,
        portal_id="f32d905a-ed33-46a3-a093-d8f536af9a8a",
        type="oidc")
    
    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.NewPortalIdentityProvider(ctx, "my_portalidentityprovider", &konnect.PortalIdentityProviderArgs{
    			Config: &konnect.PortalIdentityProviderConfigArgs{
    				OidcIdentityProviderConfig: &konnect.PortalIdentityProviderConfigOidcIdentityProviderConfigArgs{
    					ClaimMappings: &konnect.PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs{
    						Email:  pulumi.String("email"),
    						Groups: pulumi.String("groups"),
    						Name:   pulumi.String("name"),
    					},
    					ClientId:     pulumi.String("YOUR_CLIENT_ID"),
    					ClientSecret: pulumi.String("YOUR_CLIENT_SECRET"),
    					IssuerUrl:    pulumi.String("https://konghq.okta.com/oauth2/default"),
    					Scopes: pulumi.StringArray{
    						pulumi.String("..."),
    					},
    				},
    			},
    			Enabled:  pulumi.Bool(true),
    			PortalId: pulumi.String("f32d905a-ed33-46a3-a093-d8f536af9a8a"),
    			Type:     pulumi.String("oidc"),
    		})
    		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 myPortalidentityprovider = new Konnect.PortalIdentityProvider("my_portalidentityprovider", new()
        {
            Config = new Konnect.Inputs.PortalIdentityProviderConfigArgs
            {
                OidcIdentityProviderConfig = new Konnect.Inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigArgs
                {
                    ClaimMappings = new Konnect.Inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs
                    {
                        Email = "email",
                        Groups = "groups",
                        Name = "name",
                    },
                    ClientId = "YOUR_CLIENT_ID",
                    ClientSecret = "YOUR_CLIENT_SECRET",
                    IssuerUrl = "https://konghq.okta.com/oauth2/default",
                    Scopes = new[]
                    {
                        "...",
                    },
                },
            },
            Enabled = true,
            PortalId = "f32d905a-ed33-46a3-a093-d8f536af9a8a",
            Type = "oidc",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.PortalIdentityProvider;
    import com.pulumi.konnect.PortalIdentityProviderArgs;
    import com.pulumi.konnect.inputs.PortalIdentityProviderConfigArgs;
    import com.pulumi.konnect.inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigArgs;
    import com.pulumi.konnect.inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs;
    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 myPortalidentityprovider = new PortalIdentityProvider("myPortalidentityprovider", PortalIdentityProviderArgs.builder()
                .config(PortalIdentityProviderConfigArgs.builder()
                    .oidcIdentityProviderConfig(PortalIdentityProviderConfigOidcIdentityProviderConfigArgs.builder()
                        .claimMappings(PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs.builder()
                            .email("email")
                            .groups("groups")
                            .name("name")
                            .build())
                        .clientId("YOUR_CLIENT_ID")
                        .clientSecret("YOUR_CLIENT_SECRET")
                        .issuerUrl("https://konghq.okta.com/oauth2/default")
                        .scopes("...")
                        .build())
                    .build())
                .enabled(true)
                .portalId("f32d905a-ed33-46a3-a093-d8f536af9a8a")
                .type("oidc")
                .build());
    
        }
    }
    
    resources:
      myPortalidentityprovider:
        type: konnect:PortalIdentityProvider
        name: my_portalidentityprovider
        properties:
          config:
            oidcIdentityProviderConfig:
              claimMappings:
                email: email
                groups: groups
                name: name
              clientId: YOUR_CLIENT_ID
              clientSecret: YOUR_CLIENT_SECRET
              issuerUrl: https://konghq.okta.com/oauth2/default
              scopes:
                - '...'
          enabled: true
          portalId: f32d905a-ed33-46a3-a093-d8f536af9a8a
          type: oidc
    
    Example coming soon!
    

    Create PortalIdentityProvider Resource

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

    Constructor syntax

    new PortalIdentityProvider(name: string, args: PortalIdentityProviderArgs, opts?: CustomResourceOptions);
    @overload
    def PortalIdentityProvider(resource_name: str,
                               args: PortalIdentityProviderArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def PortalIdentityProvider(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               portal_id: Optional[str] = None,
                               config: Optional[PortalIdentityProviderConfigArgs] = None,
                               enabled: Optional[bool] = None,
                               type: Optional[str] = None)
    func NewPortalIdentityProvider(ctx *Context, name string, args PortalIdentityProviderArgs, opts ...ResourceOption) (*PortalIdentityProvider, error)
    public PortalIdentityProvider(string name, PortalIdentityProviderArgs args, CustomResourceOptions? opts = null)
    public PortalIdentityProvider(String name, PortalIdentityProviderArgs args)
    public PortalIdentityProvider(String name, PortalIdentityProviderArgs args, CustomResourceOptions options)
    
    type: konnect:PortalIdentityProvider
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "konnect_portal_identity_provider" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PortalIdentityProviderArgs
    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 PortalIdentityProviderArgs
    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 PortalIdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalIdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalIdentityProviderArgs
    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 portalIdentityProviderResource = new Konnect.PortalIdentityProvider("portalIdentityProviderResource", new()
    {
        PortalId = "string",
        Config = new Konnect.Inputs.PortalIdentityProviderConfigArgs
        {
            OidcIdentityProviderConfig = new Konnect.Inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigArgs
            {
                ClaimMappings = new Konnect.Inputs.PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs
                {
                    Email = "string",
                    Groups = "string",
                    Name = "string",
                },
                ClientId = "string",
                ClientSecret = "string",
                IssuerUrl = "string",
                Scopes = new[]
                {
                    "string",
                },
            },
            SamlIdentityProviderConfig = new Konnect.Inputs.PortalIdentityProviderConfigSamlIdentityProviderConfigArgs
            {
                CallbackUrl = "string",
                IdpMetadataUrl = "string",
                IdpMetadataXml = "string",
                SpEntityId = "string",
                SpMetadataUrl = "string",
            },
        },
        Enabled = false,
        Type = "string",
    });
    
    example, err := konnect.NewPortalIdentityProvider(ctx, "portalIdentityProviderResource", &konnect.PortalIdentityProviderArgs{
    	PortalId: pulumi.String("string"),
    	Config: &konnect.PortalIdentityProviderConfigArgs{
    		OidcIdentityProviderConfig: &konnect.PortalIdentityProviderConfigOidcIdentityProviderConfigArgs{
    			ClaimMappings: &konnect.PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs{
    				Email:  pulumi.String("string"),
    				Groups: pulumi.String("string"),
    				Name:   pulumi.String("string"),
    			},
    			ClientId:     pulumi.String("string"),
    			ClientSecret: pulumi.String("string"),
    			IssuerUrl:    pulumi.String("string"),
    			Scopes: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    		SamlIdentityProviderConfig: &konnect.PortalIdentityProviderConfigSamlIdentityProviderConfigArgs{
    			CallbackUrl:    pulumi.String("string"),
    			IdpMetadataUrl: pulumi.String("string"),
    			IdpMetadataXml: pulumi.String("string"),
    			SpEntityId:     pulumi.String("string"),
    			SpMetadataUrl:  pulumi.String("string"),
    		},
    	},
    	Enabled: pulumi.Bool(false),
    	Type:    pulumi.String("string"),
    })
    
    resource "konnect_portal_identity_provider" "portalIdentityProviderResource" {
      lifecycle {
        create_before_destroy = true
      }
      portal_id = "string"
      config = {
        oidc_identity_provider_config = {
          claim_mappings = {
            email  = "string"
            groups = "string"
            name   = "string"
          }
          client_id     = "string"
          client_secret = "string"
          issuer_url    = "string"
          scopes        = ["string"]
        }
        saml_identity_provider_config = {
          callback_url     = "string"
          idp_metadata_url = "string"
          idp_metadata_xml = "string"
          sp_entity_id     = "string"
          sp_metadata_url  = "string"
        }
      }
      enabled = false
      type    = "string"
    }
    
    var portalIdentityProviderResource = new PortalIdentityProvider("portalIdentityProviderResource", PortalIdentityProviderArgs.builder()
        .portalId("string")
        .config(PortalIdentityProviderConfigArgs.builder()
            .oidcIdentityProviderConfig(PortalIdentityProviderConfigOidcIdentityProviderConfigArgs.builder()
                .claimMappings(PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs.builder()
                    .email("string")
                    .groups("string")
                    .name("string")
                    .build())
                .clientId("string")
                .clientSecret("string")
                .issuerUrl("string")
                .scopes("string")
                .build())
            .samlIdentityProviderConfig(PortalIdentityProviderConfigSamlIdentityProviderConfigArgs.builder()
                .callbackUrl("string")
                .idpMetadataUrl("string")
                .idpMetadataXml("string")
                .spEntityId("string")
                .spMetadataUrl("string")
                .build())
            .build())
        .enabled(false)
        .type("string")
        .build());
    
    portal_identity_provider_resource = konnect.PortalIdentityProvider("portalIdentityProviderResource",
        portal_id="string",
        config={
            "oidc_identity_provider_config": {
                "claim_mappings": {
                    "email": "string",
                    "groups": "string",
                    "name": "string",
                },
                "client_id": "string",
                "client_secret": "string",
                "issuer_url": "string",
                "scopes": ["string"],
            },
            "saml_identity_provider_config": {
                "callback_url": "string",
                "idp_metadata_url": "string",
                "idp_metadata_xml": "string",
                "sp_entity_id": "string",
                "sp_metadata_url": "string",
            },
        },
        enabled=False,
        type="string")
    
    const portalIdentityProviderResource = new konnect.PortalIdentityProvider("portalIdentityProviderResource", {
        portalId: "string",
        config: {
            oidcIdentityProviderConfig: {
                claimMappings: {
                    email: "string",
                    groups: "string",
                    name: "string",
                },
                clientId: "string",
                clientSecret: "string",
                issuerUrl: "string",
                scopes: ["string"],
            },
            samlIdentityProviderConfig: {
                callbackUrl: "string",
                idpMetadataUrl: "string",
                idpMetadataXml: "string",
                spEntityId: "string",
                spMetadataUrl: "string",
            },
        },
        enabled: false,
        type: "string",
    });
    
    type: konnect:PortalIdentityProvider
    properties:
        config:
            oidcIdentityProviderConfig:
                claimMappings:
                    email: string
                    groups: string
                    name: string
                clientId: string
                clientSecret: string
                issuerUrl: string
                scopes:
                    - string
            samlIdentityProviderConfig:
                callbackUrl: string
                idpMetadataUrl: string
                idpMetadataXml: string
                spEntityId: string
                spMetadataUrl: string
        enabled: false
        portalId: string
        type: string
    

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

    PortalId string
    The Portal identifier
    Config PortalIdentityProviderConfig
    Enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    Type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    PortalId string
    The Portal identifier
    Config PortalIdentityProviderConfigArgs
    Enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    Type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    portal_id string
    The Portal identifier
    config object
    enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    portalId String
    The Portal identifier
    config PortalIdentityProviderConfig
    enabled Boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    type String
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    portalId string
    The Portal identifier
    config PortalIdentityProviderConfig
    enabled boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    portal_id str
    The Portal identifier
    config PortalIdentityProviderConfigArgs
    enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    type str
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    portalId String
    The Portal identifier
    config Property Map
    enabled Boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    type String
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.

    Outputs

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

    Get an existing PortalIdentityProvider 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?: PortalIdentityProviderState, opts?: CustomResourceOptions): PortalIdentityProvider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[PortalIdentityProviderConfigArgs] = None,
            created_at: Optional[str] = None,
            enabled: Optional[bool] = None,
            portal_id: Optional[str] = None,
            type: Optional[str] = None,
            updated_at: Optional[str] = None) -> PortalIdentityProvider
    func GetPortalIdentityProvider(ctx *Context, name string, id IDInput, state *PortalIdentityProviderState, opts ...ResourceOption) (*PortalIdentityProvider, error)
    public static PortalIdentityProvider Get(string name, Input<string> id, PortalIdentityProviderState? state, CustomResourceOptions? opts = null)
    public static PortalIdentityProvider get(String name, Output<String> id, PortalIdentityProviderState state, CustomResourceOptions options)
    resources:  _:    type: konnect:PortalIdentityProvider    get:      id: ${id}
    import {
      to = konnect_portal_identity_provider.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:
    Config PortalIdentityProviderConfig
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    PortalId string
    The Portal identifier
    Type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Config PortalIdentityProviderConfigArgs
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    PortalId string
    The Portal identifier
    Type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    config object
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    portal_id string
    The Portal identifier
    type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    config PortalIdentityProviderConfig
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    portalId String
    The Portal identifier
    type String
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    config PortalIdentityProviderConfig
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    enabled boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    portalId string
    The Portal identifier
    type string
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    config PortalIdentityProviderConfigArgs
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    enabled bool
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    portal_id str
    The Portal identifier
    type str
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    config Property Map
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC. Default: false
    portalId String
    The Portal identifier
    type String
    Specifies the type of identity provider. possible known values include one of ["oidc", "saml"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    PortalIdentityProviderConfig, PortalIdentityProviderConfigArgs

    OidcIdentityProviderConfig PortalIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    SamlIdentityProviderConfig PortalIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    OidcIdentityProviderConfig PortalIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    SamlIdentityProviderConfig PortalIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidc_identity_provider_config object
    The identity provider that contains configuration data for the OIDC authentication integration.
    saml_identity_provider_config object
    The identity provider that contains configuration data for the SAML authentication integration.
    oidcIdentityProviderConfig PortalIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    samlIdentityProviderConfig PortalIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidcIdentityProviderConfig PortalIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    samlIdentityProviderConfig PortalIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidc_identity_provider_config PortalIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    saml_identity_provider_config PortalIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidcIdentityProviderConfig Property Map
    The identity provider that contains configuration data for the OIDC authentication integration.
    samlIdentityProviderConfig Property Map
    The identity provider that contains configuration data for the SAML authentication integration.

    PortalIdentityProviderConfigOidcIdentityProviderConfig, PortalIdentityProviderConfigOidcIdentityProviderConfigArgs

    ClaimMappings PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    ClientId string
    The client ID assigned to your application by the identity provider. Not Null
    ClientSecret string
    The Client Secret assigned to your application by the identity provider.
    IssuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    Scopes List<string>
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    ClaimMappings PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    ClientId string
    The client ID assigned to your application by the identity provider. Not Null
    ClientSecret string
    The Client Secret assigned to your application by the identity provider.
    IssuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    Scopes []string
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    claim_mappings object
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    client_id string
    The client ID assigned to your application by the identity provider. Not Null
    client_secret string
    The Client Secret assigned to your application by the identity provider.
    issuer_url string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    scopes list(string)
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    claimMappings PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    clientId String
    The client ID assigned to your application by the identity provider. Not Null
    clientSecret String
    The Client Secret assigned to your application by the identity provider.
    issuerUrl String
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    scopes List<String>
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    claimMappings PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    clientId string
    The client ID assigned to your application by the identity provider. Not Null
    clientSecret string
    The Client Secret assigned to your application by the identity provider.
    issuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    scopes string[]
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    claim_mappings PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    client_id str
    The client ID assigned to your application by the identity provider. Not Null
    client_secret str
    The Client Secret assigned to your application by the identity provider.
    issuer_url str
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    scopes Sequence[str]
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]
    claimMappings Property Map
    Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
    clientId String
    The client ID assigned to your application by the identity provider. Not Null
    clientSecret String
    The Client Secret assigned to your application by the identity provider.
    issuerUrl String
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained. Not Null
    scopes List<String>
    The scopes requested by your application when authenticating with the identity provider. Default: ["email","openid","profile"]

    PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappings, PortalIdentityProviderConfigOidcIdentityProviderConfigClaimMappingsArgs

    Email string
    The claim mapping for the user's email address. Default: "email"
    Groups string
    The claim mapping for the user's group membership information. Default: "groups"
    Name string
    The claim mapping for the user's name. Default: "name"
    Email string
    The claim mapping for the user's email address. Default: "email"
    Groups string
    The claim mapping for the user's group membership information. Default: "groups"
    Name string
    The claim mapping for the user's name. Default: "name"
    email string
    The claim mapping for the user's email address. Default: "email"
    groups string
    The claim mapping for the user's group membership information. Default: "groups"
    name string
    The claim mapping for the user's name. Default: "name"
    email String
    The claim mapping for the user's email address. Default: "email"
    groups String
    The claim mapping for the user's group membership information. Default: "groups"
    name String
    The claim mapping for the user's name. Default: "name"
    email string
    The claim mapping for the user's email address. Default: "email"
    groups string
    The claim mapping for the user's group membership information. Default: "groups"
    name string
    The claim mapping for the user's name. Default: "name"
    email str
    The claim mapping for the user's email address. Default: "email"
    groups str
    The claim mapping for the user's group membership information. Default: "groups"
    name str
    The claim mapping for the user's name. Default: "name"
    email String
    The claim mapping for the user's email address. Default: "email"
    groups String
    The claim mapping for the user's group membership information. Default: "groups"
    name String
    The claim mapping for the user's name. Default: "name"

    PortalIdentityProviderConfigSamlIdentityProviderConfig, PortalIdentityProviderConfigSamlIdentityProviderConfigArgs

    CallbackUrl string
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    IdpMetadataUrl string
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    IdpMetadataXml string
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    SpEntityId string
    The entity ID of the service provider (SP).
    SpMetadataUrl string
    CallbackUrl string
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    IdpMetadataUrl string
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    IdpMetadataXml string
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    SpEntityId string
    The entity ID of the service provider (SP).
    SpMetadataUrl string
    callback_url string
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    idp_metadata_url string
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    idp_metadata_xml string
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    sp_entity_id string
    The entity ID of the service provider (SP).
    sp_metadata_url string
    callbackUrl String
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    idpMetadataUrl String
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    idpMetadataXml String
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    spEntityId String
    The entity ID of the service provider (SP).
    spMetadataUrl String
    callbackUrl string
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    idpMetadataUrl string
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    idpMetadataXml string
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    spEntityId string
    The entity ID of the service provider (SP).
    spMetadataUrl string
    callback_url str
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    idp_metadata_url str
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    idp_metadata_xml str
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    sp_entity_id str
    The entity ID of the service provider (SP).
    sp_metadata_url str
    callbackUrl String
    The path URL where the SAML identity provider sends authentication responses after successful login attempts.
    idpMetadataUrl String
    The identity provider's metadata URL where the identity provider's metadata can be obtained. Default: ""
    idpMetadataXml String
    The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead. Default: ""
    spEntityId String
    The entity ID of the service provider (SP).
    spMetadataUrl String

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_portal_identity_provider.my_konnect_portal_identity_provider

    id = jsonencode({

    id        = "d32d905a-ed33-46a3-a093-d8f536af9a8a"
    
    portal_id = "f32d905a-ed33-46a3-a093-d8f536af9a8a"
    

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/portalIdentityProvider:PortalIdentityProvider my_konnect_portal_identity_provider '{"id": "d32d905a-ed33-46a3-a093-d8f536af9a8a", "portal_id": "f32d905a-ed33-46a3-a093-d8f536af9a8a"}'
    

    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.
    Viewing docs for konnect 3.23.0
    published on Friday, Sep 18, 2026 by kong

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial