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

    IdentityProvider DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myIdentityprovider = konnect.getIdentityProvider({
        id: "d32d905a-ed33-46a3-a093-d8f536af9a8a",
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_identityprovider = konnect.get_identity_provider(id="d32d905a-ed33-46a3-a093-d8f536af9a8a")
    
    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.LookupIdentityProvider(ctx, &konnect.LookupIdentityProviderArgs{
    			Id: "d32d905a-ed33-46a3-a093-d8f536af9a8a",
    		}, nil)
    		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 myIdentityprovider = Konnect.GetIdentityProvider.Invoke(new()
        {
            Id = "d32d905a-ed33-46a3-a093-d8f536af9a8a",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.KonnectFunctions;
    import com.pulumi.konnect.inputs.GetIdentityProviderArgs;
    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) {
            final var myIdentityprovider = KonnectFunctions.getIdentityProvider(GetIdentityProviderArgs.builder()
                .id("d32d905a-ed33-46a3-a093-d8f536af9a8a")
                .build());
    
        }
    }
    
    variables:
      myIdentityprovider:
        fn::invoke:
          function: konnect:getIdentityProvider
          arguments:
            id: d32d905a-ed33-46a3-a093-d8f536af9a8a
    
    Example coming soon!
    

    Using getIdentityProvider

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdentityProvider(args: GetIdentityProviderArgs, opts?: InvokeOptions): Promise<GetIdentityProviderResult>
    function getIdentityProviderOutput(args: GetIdentityProviderOutputArgs, opts?: InvokeOutputOptions): Output<GetIdentityProviderResult>
    def get_identity_provider(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetIdentityProviderResult
    def get_identity_provider_output(id: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetIdentityProviderResult]
    func LookupIdentityProvider(ctx *Context, args *LookupIdentityProviderArgs, opts ...InvokeOption) (*LookupIdentityProviderResult, error)
    func LookupIdentityProviderOutput(ctx *Context, args *LookupIdentityProviderOutputArgs, opts ...InvokeOption) LookupIdentityProviderResultOutput

    > Note: This function is named LookupIdentityProvider in the Go SDK.

    public static class GetIdentityProvider 
    {
        public static Task<GetIdentityProviderResult> InvokeAsync(GetIdentityProviderArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentityProviderResult> Invoke(GetIdentityProviderInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentityProviderResult> Invoke(GetIdentityProviderInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetIdentityProviderResult> getIdentityProvider(GetIdentityProviderArgs args, InvokeOptions options)
    public static Output<GetIdentityProviderResult> getIdentityProvider(GetIdentityProviderArgs args, InvokeOptions options)
    public static Output<GetIdentityProviderResult> getIdentityProvider(GetIdentityProviderArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: konnect:index/getIdentityProvider:getIdentityProvider
      arguments:
        # arguments dictionary
    data "konnect_get_identity_provider" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Contains a unique identifier used for this resource.
    Id string
    Contains a unique identifier used for this resource.
    id string
    Contains a unique identifier used for this resource.
    id String
    Contains a unique identifier used for this resource.
    id string
    Contains a unique identifier used for this resource.
    id str
    Contains a unique identifier used for this resource.
    id String
    Contains a unique identifier used for this resource.

    getIdentityProvider Result

    The following output properties are available:

    Config GetIdentityProviderConfig
    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.
    Id string
    Contains a unique identifier used for this resource.
    LoginPath string
    The path used for initiating login requests with the identity provider.
    Type string
    Specifies the type of identity provider.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Config GetIdentityProviderConfig
    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.
    Id string
    Contains a unique identifier used for this resource.
    LoginPath string
    The path used for initiating login requests with the identity provider.
    Type string
    Specifies the type of identity provider.
    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.
    id string
    Contains a unique identifier used for this resource.
    login_path string
    The path used for initiating login requests with the identity provider.
    type string
    Specifies the type of identity provider.
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    config GetIdentityProviderConfig
    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.
    id String
    Contains a unique identifier used for this resource.
    loginPath String
    The path used for initiating login requests with the identity provider.
    type String
    Specifies the type of identity provider.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    config GetIdentityProviderConfig
    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.
    id string
    Contains a unique identifier used for this resource.
    loginPath string
    The path used for initiating login requests with the identity provider.
    type string
    Specifies the type of identity provider.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    config GetIdentityProviderConfig
    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.
    id str
    Contains a unique identifier used for this resource.
    login_path str
    The path used for initiating login requests with the identity provider.
    type str
    Specifies the type of identity provider.
    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.
    id String
    Contains a unique identifier used for this resource.
    loginPath String
    The path used for initiating login requests with the identity provider.
    type String
    Specifies the type of identity provider.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    GetIdentityProviderConfig

    OidcIdentityProviderConfig GetIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    SamlIdentityProviderConfig GetIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    OidcIdentityProviderConfig GetIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    SamlIdentityProviderConfig GetIdentityProviderConfigSamlIdentityProviderConfig
    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 GetIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    samlIdentityProviderConfig GetIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidcIdentityProviderConfig GetIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    samlIdentityProviderConfig GetIdentityProviderConfigSamlIdentityProviderConfig
    The identity provider that contains configuration data for the SAML authentication integration.
    oidc_identity_provider_config GetIdentityProviderConfigOidcIdentityProviderConfig
    The identity provider that contains configuration data for the OIDC authentication integration.
    saml_identity_provider_config GetIdentityProviderConfigSamlIdentityProviderConfig
    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.

    GetIdentityProviderConfigOidcIdentityProviderConfig

    ClaimMappings GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    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.
    IssuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    Scopes List<string>
    The scopes requested by your application when authenticating with the identity provider.
    ClaimMappings GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    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.
    IssuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    Scopes []string
    The scopes requested by your application when authenticating with the identity provider.
    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.
    issuer_url string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    scopes list(string)
    The scopes requested by your application when authenticating with the identity provider.
    claimMappings GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    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.
    issuerUrl String
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    scopes List<String>
    The scopes requested by your application when authenticating with the identity provider.
    claimMappings GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    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.
    issuerUrl string
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    scopes string[]
    The scopes requested by your application when authenticating with the identity provider.
    claim_mappings GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings
    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.
    issuer_url str
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    scopes Sequence[str]
    The scopes requested by your application when authenticating with the identity provider.
    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.
    issuerUrl String
    The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
    scopes List<String>
    The scopes requested by your application when authenticating with the identity provider.

    GetIdentityProviderConfigOidcIdentityProviderConfigClaimMappings

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

    GetIdentityProviderConfigSamlIdentityProviderConfig

    CallbackUrl string
    The 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.
    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.
    LoginUrl string
    The URL to redirect users to for initiating login with the identity provider.
    SpEntityId string
    The entity ID of the service provider (SP).
    SpMetadataUrl string
    CallbackUrl string
    The 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.
    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.
    LoginUrl string
    The URL to redirect users to for initiating login with the identity provider.
    SpEntityId string
    The entity ID of the service provider (SP).
    SpMetadataUrl string
    callback_url string
    The 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.
    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.
    login_url string
    The URL to redirect users to for initiating login with the identity provider.
    sp_entity_id string
    The entity ID of the service provider (SP).
    sp_metadata_url string
    callbackUrl String
    The 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.
    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.
    loginUrl String
    The URL to redirect users to for initiating login with the identity provider.
    spEntityId String
    The entity ID of the service provider (SP).
    spMetadataUrl String
    callbackUrl string
    The 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.
    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.
    loginUrl string
    The URL to redirect users to for initiating login with the identity provider.
    spEntityId string
    The entity ID of the service provider (SP).
    spMetadataUrl string
    callback_url str
    The 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.
    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.
    login_url str
    The URL to redirect users to for initiating login with the identity provider.
    sp_entity_id str
    The entity ID of the service provider (SP).
    sp_metadata_url str
    callbackUrl String
    The 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.
    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.
    loginUrl String
    The URL to redirect users to for initiating login with the identity provider.
    spEntityId String
    The entity ID of the service provider (SP).
    spMetadataUrl String

    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.24.0
    published on Friday, Sep 25, 2026 by kong

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial