1. Packages
  2. Konnect Provider
  3. API Docs
  4. AuthenticationSettings
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong
konnect logo
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong

    AuthenticationSettings Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myAuthenticationsettings = new konnect.AuthenticationSettings("my_authenticationsettings", {
        basicAuthEnabled: true,
        idpMappingEnabled: true,
        konnectMappingEnabled: false,
        oidcAuthEnabled: false,
        samlAuthEnabled: false,
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_authenticationsettings = konnect.AuthenticationSettings("my_authenticationsettings",
        basic_auth_enabled=True,
        idp_mapping_enabled=True,
        konnect_mapping_enabled=False,
        oidc_auth_enabled=False,
        saml_auth_enabled=False)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := konnect.NewAuthenticationSettings(ctx, "my_authenticationsettings", &konnect.AuthenticationSettingsArgs{
    			BasicAuthEnabled:      pulumi.Bool(true),
    			IdpMappingEnabled:     pulumi.Bool(true),
    			KonnectMappingEnabled: pulumi.Bool(false),
    			OidcAuthEnabled:       pulumi.Bool(false),
    			SamlAuthEnabled:       pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Konnect = Pulumi.Konnect;
    
    return await Deployment.RunAsync(() => 
    {
        var myAuthenticationsettings = new Konnect.AuthenticationSettings("my_authenticationsettings", new()
        {
            BasicAuthEnabled = true,
            IdpMappingEnabled = true,
            KonnectMappingEnabled = false,
            OidcAuthEnabled = false,
            SamlAuthEnabled = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.AuthenticationSettings;
    import com.pulumi.konnect.AuthenticationSettingsArgs;
    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 myAuthenticationsettings = new AuthenticationSettings("myAuthenticationsettings", AuthenticationSettingsArgs.builder()
                .basicAuthEnabled(true)
                .idpMappingEnabled(true)
                .konnectMappingEnabled(false)
                .oidcAuthEnabled(false)
                .samlAuthEnabled(false)
                .build());
    
        }
    }
    
    resources:
      myAuthenticationsettings:
        type: konnect:AuthenticationSettings
        name: my_authenticationsettings
        properties:
          basicAuthEnabled: true
          idpMappingEnabled: true
          konnectMappingEnabled: false
          oidcAuthEnabled: false
          samlAuthEnabled: false
    

    Create AuthenticationSettings Resource

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

    Constructor syntax

    new AuthenticationSettings(name: string, args?: AuthenticationSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def AuthenticationSettings(resource_name: str,
                               args: Optional[AuthenticationSettingsArgs] = None,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthenticationSettings(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               basic_auth_enabled: Optional[bool] = None,
                               idp_mapping_enabled: Optional[bool] = None,
                               konnect_mapping_enabled: Optional[bool] = None,
                               oidc_auth_enabled: Optional[bool] = None,
                               saml_auth_enabled: Optional[bool] = None)
    func NewAuthenticationSettings(ctx *Context, name string, args *AuthenticationSettingsArgs, opts ...ResourceOption) (*AuthenticationSettings, error)
    public AuthenticationSettings(string name, AuthenticationSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public AuthenticationSettings(String name, AuthenticationSettingsArgs args)
    public AuthenticationSettings(String name, AuthenticationSettingsArgs args, CustomResourceOptions options)
    
    type: konnect:AuthenticationSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AuthenticationSettingsArgs
    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 AuthenticationSettingsArgs
    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 AuthenticationSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthenticationSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthenticationSettingsArgs
    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 authenticationSettingsResource = new Konnect.AuthenticationSettings("authenticationSettingsResource", new()
    {
        BasicAuthEnabled = false,
        IdpMappingEnabled = false,
        KonnectMappingEnabled = false,
        OidcAuthEnabled = false,
        SamlAuthEnabled = false,
    });
    
    example, err := konnect.NewAuthenticationSettings(ctx, "authenticationSettingsResource", &konnect.AuthenticationSettingsArgs{
    	BasicAuthEnabled:      pulumi.Bool(false),
    	IdpMappingEnabled:     pulumi.Bool(false),
    	KonnectMappingEnabled: pulumi.Bool(false),
    	OidcAuthEnabled:       pulumi.Bool(false),
    	SamlAuthEnabled:       pulumi.Bool(false),
    })
    
    var authenticationSettingsResource = new AuthenticationSettings("authenticationSettingsResource", AuthenticationSettingsArgs.builder()
        .basicAuthEnabled(false)
        .idpMappingEnabled(false)
        .konnectMappingEnabled(false)
        .oidcAuthEnabled(false)
        .samlAuthEnabled(false)
        .build());
    
    authentication_settings_resource = konnect.AuthenticationSettings("authenticationSettingsResource",
        basic_auth_enabled=False,
        idp_mapping_enabled=False,
        konnect_mapping_enabled=False,
        oidc_auth_enabled=False,
        saml_auth_enabled=False)
    
    const authenticationSettingsResource = new konnect.AuthenticationSettings("authenticationSettingsResource", {
        basicAuthEnabled: false,
        idpMappingEnabled: false,
        konnectMappingEnabled: false,
        oidcAuthEnabled: false,
        samlAuthEnabled: false,
    });
    
    type: konnect:AuthenticationSettings
    properties:
        basicAuthEnabled: false
        idpMappingEnabled: false
        konnectMappingEnabled: false
        oidcAuthEnabled: false
        samlAuthEnabled: false
    

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

    BasicAuthEnabled bool
    The organization has basic auth enabled.
    IdpMappingEnabled bool
    Whether IdP groups determine the Konnect teams a user has.
    KonnectMappingEnabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    OidcAuthEnabled bool
    The organization has OIDC disabled.
    SamlAuthEnabled bool
    The organization has SAML disabled.
    BasicAuthEnabled bool
    The organization has basic auth enabled.
    IdpMappingEnabled bool
    Whether IdP groups determine the Konnect teams a user has.
    KonnectMappingEnabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    OidcAuthEnabled bool
    The organization has OIDC disabled.
    SamlAuthEnabled bool
    The organization has SAML disabled.
    basicAuthEnabled Boolean
    The organization has basic auth enabled.
    idpMappingEnabled Boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled Boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled Boolean
    The organization has OIDC disabled.
    samlAuthEnabled Boolean
    The organization has SAML disabled.
    basicAuthEnabled boolean
    The organization has basic auth enabled.
    idpMappingEnabled boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled boolean
    The organization has OIDC disabled.
    samlAuthEnabled boolean
    The organization has SAML disabled.
    basic_auth_enabled bool
    The organization has basic auth enabled.
    idp_mapping_enabled bool
    Whether IdP groups determine the Konnect teams a user has.
    konnect_mapping_enabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    oidc_auth_enabled bool
    The organization has OIDC disabled.
    saml_auth_enabled bool
    The organization has SAML disabled.
    basicAuthEnabled Boolean
    The organization has basic auth enabled.
    idpMappingEnabled Boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled Boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled Boolean
    The organization has OIDC disabled.
    samlAuthEnabled Boolean
    The organization has SAML disabled.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthenticationSettings Resource

    Get an existing AuthenticationSettings 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?: AuthenticationSettingsState, opts?: CustomResourceOptions): AuthenticationSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            basic_auth_enabled: Optional[bool] = None,
            idp_mapping_enabled: Optional[bool] = None,
            konnect_mapping_enabled: Optional[bool] = None,
            oidc_auth_enabled: Optional[bool] = None,
            saml_auth_enabled: Optional[bool] = None) -> AuthenticationSettings
    func GetAuthenticationSettings(ctx *Context, name string, id IDInput, state *AuthenticationSettingsState, opts ...ResourceOption) (*AuthenticationSettings, error)
    public static AuthenticationSettings Get(string name, Input<string> id, AuthenticationSettingsState? state, CustomResourceOptions? opts = null)
    public static AuthenticationSettings get(String name, Output<String> id, AuthenticationSettingsState state, CustomResourceOptions options)
    resources:  _:    type: konnect:AuthenticationSettings    get:      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:
    BasicAuthEnabled bool
    The organization has basic auth enabled.
    IdpMappingEnabled bool
    Whether IdP groups determine the Konnect teams a user has.
    KonnectMappingEnabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    OidcAuthEnabled bool
    The organization has OIDC disabled.
    SamlAuthEnabled bool
    The organization has SAML disabled.
    BasicAuthEnabled bool
    The organization has basic auth enabled.
    IdpMappingEnabled bool
    Whether IdP groups determine the Konnect teams a user has.
    KonnectMappingEnabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    OidcAuthEnabled bool
    The organization has OIDC disabled.
    SamlAuthEnabled bool
    The organization has SAML disabled.
    basicAuthEnabled Boolean
    The organization has basic auth enabled.
    idpMappingEnabled Boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled Boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled Boolean
    The organization has OIDC disabled.
    samlAuthEnabled Boolean
    The organization has SAML disabled.
    basicAuthEnabled boolean
    The organization has basic auth enabled.
    idpMappingEnabled boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled boolean
    The organization has OIDC disabled.
    samlAuthEnabled boolean
    The organization has SAML disabled.
    basic_auth_enabled bool
    The organization has basic auth enabled.
    idp_mapping_enabled bool
    Whether IdP groups determine the Konnect teams a user has.
    konnect_mapping_enabled bool
    Whether a Konnect Identity Admin assigns teams to a user.
    oidc_auth_enabled bool
    The organization has OIDC disabled.
    saml_auth_enabled bool
    The organization has SAML disabled.
    basicAuthEnabled Boolean
    The organization has basic auth enabled.
    idpMappingEnabled Boolean
    Whether IdP groups determine the Konnect teams a user has.
    konnectMappingEnabled Boolean
    Whether a Konnect Identity Admin assigns teams to a user.
    oidcAuthEnabled Boolean
    The organization has OIDC disabled.
    samlAuthEnabled Boolean
    The organization has SAML disabled.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    Viewing docs for konnect 3.11.0
    published on Thursday, Mar 12, 2026 by kong
      Try Pulumi Cloud free. Your team will thank you.