Docs Packages
  1. Packages
  2. Zitadel
  3. API Docs
  4. IdpLdap
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.IdpLdap

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing an LDAP IDP on the instance.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.IdpLdap("default", new()
    {
        BaseDn = "dc=example,dc=com",
        BindDn = "cn=admin,dc=example,dc=com",
        BindPassword = "Password1!",
        FirstNameAttribute = "firstname",
        IdAttribute = "uid",
        IsAutoCreation = false,
        IsAutoUpdate = true,
        IsCreationAllowed = true,
        IsLinkingAllowed = false,
        LastNameAttribute = "lastname",
        Servers = new[]
        {
            "ldaps://my.primary.server:389",
            "ldaps://my.secondary.server:389",
        },
        StartTls = false,
        Timeout = "10s",
        UserBase = "dn",
        UserFilters = new[]
        {
            "uid",
            "email",
        },
        UserObjectClasses = new[]
        {
            "inetOrgPerson",
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.NewIdpLdap(ctx, "default", &zitadel.IdpLdapArgs{
			BaseDn:             pulumi.String("dc=example,dc=com"),
			BindDn:             pulumi.String("cn=admin,dc=example,dc=com"),
			BindPassword:       pulumi.String("Password1!"),
			FirstNameAttribute: pulumi.String("firstname"),
			IdAttribute:        pulumi.String("uid"),
			IsAutoCreation:     pulumi.Bool(false),
			IsAutoUpdate:       pulumi.Bool(true),
			IsCreationAllowed:  pulumi.Bool(true),
			IsLinkingAllowed:   pulumi.Bool(false),
			LastNameAttribute:  pulumi.String("lastname"),
			Servers: pulumi.StringArray{
				pulumi.String("ldaps://my.primary.server:389"),
				pulumi.String("ldaps://my.secondary.server:389"),
			},
			StartTls: pulumi.Bool(false),
			Timeout:  pulumi.String("10s"),
			UserBase: pulumi.String("dn"),
			UserFilters: pulumi.StringArray{
				pulumi.String("uid"),
				pulumi.String("email"),
			},
			UserObjectClasses: pulumi.StringArray{
				pulumi.String("inetOrgPerson"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.IdpLdap;
import com.pulumi.zitadel.IdpLdapArgs;
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 default_ = new IdpLdap("default", IdpLdapArgs.builder()        
            .baseDn("dc=example,dc=com")
            .bindDn("cn=admin,dc=example,dc=com")
            .bindPassword("Password1!")
            .firstNameAttribute("firstname")
            .idAttribute("uid")
            .isAutoCreation(false)
            .isAutoUpdate(true)
            .isCreationAllowed(true)
            .isLinkingAllowed(false)
            .lastNameAttribute("lastname")
            .servers(            
                "ldaps://my.primary.server:389",
                "ldaps://my.secondary.server:389")
            .startTls(false)
            .timeout("10s")
            .userBase("dn")
            .userFilters(            
                "uid",
                "email")
            .userObjectClasses("inetOrgPerson")
            .build());

    }
}

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.IdpLdap("default",
    base_dn="dc=example,dc=com",
    bind_dn="cn=admin,dc=example,dc=com",
    bind_password="Password1!",
    first_name_attribute="firstname",
    id_attribute="uid",
    is_auto_creation=False,
    is_auto_update=True,
    is_creation_allowed=True,
    is_linking_allowed=False,
    last_name_attribute="lastname",
    servers=[
        "ldaps://my.primary.server:389",
        "ldaps://my.secondary.server:389",
    ],
    start_tls=False,
    timeout="10s",
    user_base="dn",
    user_filters=[
        "uid",
        "email",
    ],
    user_object_classes=["inetOrgPerson"])

    import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";

const _default = new zitadel.IdpLdap("default", {
    baseDn: "dc=example,dc=com",
    bindDn: "cn=admin,dc=example,dc=com",
    bindPassword: "Password1!",
    firstNameAttribute: "firstname",
    idAttribute: "uid",
    isAutoCreation: false,
    isAutoUpdate: true,
    isCreationAllowed: true,
    isLinkingAllowed: false,
    lastNameAttribute: "lastname",
    servers: [
        "ldaps://my.primary.server:389",
        "ldaps://my.secondary.server:389",
    ],
    startTls: false,
    timeout: "10s",
    userBase: "dn",
    userFilters: [
        "uid",
        "email",
    ],
    userObjectClasses: ["inetOrgPerson"],
});

    resources:
  default:
    type: zitadel:IdpLdap
    properties:
      baseDn: dc=example,dc=com
      bindDn: cn=admin,dc=example,dc=com
      bindPassword: Password1!
      firstNameAttribute: firstname
      idAttribute: uid
      isAutoCreation: false
      isAutoUpdate: true
      isCreationAllowed: true
      isLinkingAllowed: false
      lastNameAttribute: lastname
      servers:
        - ldaps://my.primary.server:389
        - ldaps://my.secondary.server:389
      startTls: false
      timeout: 10s
      userBase: dn
      userFilters:
        - uid
        - email
      userObjectClasses:
        - inetOrgPerson

    Create IdpLdap Resource

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

    Constructor syntax

    new IdpLdap(name: string, args: IdpLdapArgs, opts?: CustomResourceOptions);
    @overload
def IdpLdap(resource_name: str,
            args: IdpLdapArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IdpLdap(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            servers: Optional[Sequence[str]] = None,
            base_dn: Optional[str] = None,
            bind_dn: Optional[str] = None,
            bind_password: Optional[str] = None,
            user_object_classes: Optional[Sequence[str]] = None,
            user_filters: Optional[Sequence[str]] = None,
            user_base: Optional[str] = None,
            timeout: Optional[str] = None,
            start_tls: Optional[bool] = None,
            is_auto_creation: Optional[bool] = None,
            is_auto_update: Optional[bool] = None,
            is_creation_allowed: Optional[bool] = None,
            is_linking_allowed: Optional[bool] = None,
            email_verified_attribute: Optional[str] = None,
            profile_attribute: Optional[str] = None,
            nick_name_attribute: Optional[str] = None,
            phone_attribute: Optional[str] = None,
            phone_verified_attribute: Optional[str] = None,
            preferred_language_attribute: Optional[str] = None,
            preferred_username_attribute: Optional[str] = None,
            name: Optional[str] = None,
            last_name_attribute: Optional[str] = None,
            id_attribute: Optional[str] = None,
            first_name_attribute: Optional[str] = None,
            avatar_url_attribute: Optional[str] = None,
            email_attribute: Optional[str] = None,
            display_name_attribute: Optional[str] = None)
    func NewIdpLdap(ctx *Context, name string, args IdpLdapArgs, opts ...ResourceOption) (*IdpLdap, error)
    public IdpLdap(string name, IdpLdapArgs args, CustomResourceOptions? opts = null)
    public IdpLdap(String name, IdpLdapArgs args)
public IdpLdap(String name, IdpLdapArgs args, CustomResourceOptions options)

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

    Example

    The following reference example uses placeholder values for all input properties.

    var idpLdapResource = new Zitadel.IdpLdap("idpLdapResource", new()
{
    Servers = new[]
    {
        "string",
    },
    BaseDn = "string",
    BindDn = "string",
    BindPassword = "string",
    UserObjectClasses = new[]
    {
        "string",
    },
    UserFilters = new[]
    {
        "string",
    },
    UserBase = "string",
    Timeout = "string",
    StartTls = false,
    IsAutoCreation = false,
    IsAutoUpdate = false,
    IsCreationAllowed = false,
    IsLinkingAllowed = false,
    EmailVerifiedAttribute = "string",
    ProfileAttribute = "string",
    NickNameAttribute = "string",
    PhoneAttribute = "string",
    PhoneVerifiedAttribute = "string",
    PreferredLanguageAttribute = "string",
    PreferredUsernameAttribute = "string",
    Name = "string",
    LastNameAttribute = "string",
    IdAttribute = "string",
    FirstNameAttribute = "string",
    AvatarUrlAttribute = "string",
    EmailAttribute = "string",
    DisplayNameAttribute = "string",
});

    example, err := zitadel.NewIdpLdap(ctx, "idpLdapResource", &zitadel.IdpLdapArgs{
	Servers: pulumi.StringArray{
		pulumi.String("string"),
	},
	BaseDn:       pulumi.String("string"),
	BindDn:       pulumi.String("string"),
	BindPassword: pulumi.String("string"),
	UserObjectClasses: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserBase:                   pulumi.String("string"),
	Timeout:                    pulumi.String("string"),
	StartTls:                   pulumi.Bool(false),
	IsAutoCreation:             pulumi.Bool(false),
	IsAutoUpdate:               pulumi.Bool(false),
	IsCreationAllowed:          pulumi.Bool(false),
	IsLinkingAllowed:           pulumi.Bool(false),
	EmailVerifiedAttribute:     pulumi.String("string"),
	ProfileAttribute:           pulumi.String("string"),
	NickNameAttribute:          pulumi.String("string"),
	PhoneAttribute:             pulumi.String("string"),
	PhoneVerifiedAttribute:     pulumi.String("string"),
	PreferredLanguageAttribute: pulumi.String("string"),
	PreferredUsernameAttribute: pulumi.String("string"),
	Name:                       pulumi.String("string"),
	LastNameAttribute:          pulumi.String("string"),
	IdAttribute:                pulumi.String("string"),
	FirstNameAttribute:         pulumi.String("string"),
	AvatarUrlAttribute:         pulumi.String("string"),
	EmailAttribute:             pulumi.String("string"),
	DisplayNameAttribute:       pulumi.String("string"),
})

    var idpLdapResource = new IdpLdap("idpLdapResource", IdpLdapArgs.builder()
    .servers("string")
    .baseDn("string")
    .bindDn("string")
    .bindPassword("string")
    .userObjectClasses("string")
    .userFilters("string")
    .userBase("string")
    .timeout("string")
    .startTls(false)
    .isAutoCreation(false)
    .isAutoUpdate(false)
    .isCreationAllowed(false)
    .isLinkingAllowed(false)
    .emailVerifiedAttribute("string")
    .profileAttribute("string")
    .nickNameAttribute("string")
    .phoneAttribute("string")
    .phoneVerifiedAttribute("string")
    .preferredLanguageAttribute("string")
    .preferredUsernameAttribute("string")
    .name("string")
    .lastNameAttribute("string")
    .idAttribute("string")
    .firstNameAttribute("string")
    .avatarUrlAttribute("string")
    .emailAttribute("string")
    .displayNameAttribute("string")
    .build());

    idp_ldap_resource = zitadel.IdpLdap("idpLdapResource",
    servers=["string"],
    base_dn="string",
    bind_dn="string",
    bind_password="string",
    user_object_classes=["string"],
    user_filters=["string"],
    user_base="string",
    timeout="string",
    start_tls=False,
    is_auto_creation=False,
    is_auto_update=False,
    is_creation_allowed=False,
    is_linking_allowed=False,
    email_verified_attribute="string",
    profile_attribute="string",
    nick_name_attribute="string",
    phone_attribute="string",
    phone_verified_attribute="string",
    preferred_language_attribute="string",
    preferred_username_attribute="string",
    name="string",
    last_name_attribute="string",
    id_attribute="string",
    first_name_attribute="string",
    avatar_url_attribute="string",
    email_attribute="string",
    display_name_attribute="string")

    const idpLdapResource = new zitadel.IdpLdap("idpLdapResource", {
    servers: ["string"],
    baseDn: "string",
    bindDn: "string",
    bindPassword: "string",
    userObjectClasses: ["string"],
    userFilters: ["string"],
    userBase: "string",
    timeout: "string",
    startTls: false,
    isAutoCreation: false,
    isAutoUpdate: false,
    isCreationAllowed: false,
    isLinkingAllowed: false,
    emailVerifiedAttribute: "string",
    profileAttribute: "string",
    nickNameAttribute: "string",
    phoneAttribute: "string",
    phoneVerifiedAttribute: "string",
    preferredLanguageAttribute: "string",
    preferredUsernameAttribute: "string",
    name: "string",
    lastNameAttribute: "string",
    idAttribute: "string",
    firstNameAttribute: "string",
    avatarUrlAttribute: "string",
    emailAttribute: "string",
    displayNameAttribute: "string",
});

    type: zitadel:IdpLdap
properties:
    avatarUrlAttribute: string
    baseDn: string
    bindDn: string
    bindPassword: string
    displayNameAttribute: string
    emailAttribute: string
    emailVerifiedAttribute: string
    firstNameAttribute: string
    idAttribute: string
    isAutoCreation: false
    isAutoUpdate: false
    isCreationAllowed: false
    isLinkingAllowed: false
    lastNameAttribute: string
    name: string
    nickNameAttribute: string
    phoneAttribute: string
    phoneVerifiedAttribute: string
    preferredLanguageAttribute: string
    preferredUsernameAttribute: string
    profileAttribute: string
    servers:
        - string
    startTls: false
    timeout: string
    userBase: string
    userFilters:
        - string
    userObjectClasses:
        - string

    IdpLdap Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IdpLdap resource accepts the following input properties:

    BaseDn string
    Base DN for LDAP connections
    BindDn string
    Bind DN for LDAP connections
    BindPassword string
    Bind password for LDAP connections
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Servers List<string>
    Servers to try in order for establishing LDAP connections
    StartTls bool
    Wether to use StartTLS for LDAP connections
    Timeout string
    Timeout for LDAP connections
    UserBase string
    User base for LDAP connections
    UserFilters List<string>
    User filters for LDAP connections
    UserObjectClasses List<string>
    User object classes for LDAP connections
    AvatarUrlAttribute string
    User attribute for the avatar url
    DisplayNameAttribute string
    User attribute for the display name
    EmailAttribute string
    User attribute for the email
    EmailVerifiedAttribute string
    User attribute for the email verified state
    FirstNameAttribute string
    User attribute for the first name
    IdAttribute string
    User attribute for the id
    LastNameAttribute string
    User attribute for the last name
    Name string
    Name of the IDP
    NickNameAttribute string
    User attribute for the nick name
    PhoneAttribute string
    User attribute for the phone
    PhoneVerifiedAttribute string
    User attribute for the phone verified state
    PreferredLanguageAttribute string
    User attribute for the preferred language
    PreferredUsernameAttribute string
    User attribute for the preferred username
    ProfileAttribute string
    User attribute for the profile
    BaseDn string
    Base DN for LDAP connections
    BindDn string
    Bind DN for LDAP connections
    BindPassword string
    Bind password for LDAP connections
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Servers []string
    Servers to try in order for establishing LDAP connections
    StartTls bool
    Wether to use StartTLS for LDAP connections
    Timeout string
    Timeout for LDAP connections
    UserBase string
    User base for LDAP connections
    UserFilters []string
    User filters for LDAP connections
    UserObjectClasses []string
    User object classes for LDAP connections
    AvatarUrlAttribute string
    User attribute for the avatar url
    DisplayNameAttribute string
    User attribute for the display name
    EmailAttribute string
    User attribute for the email
    EmailVerifiedAttribute string
    User attribute for the email verified state
    FirstNameAttribute string
    User attribute for the first name
    IdAttribute string
    User attribute for the id
    LastNameAttribute string
    User attribute for the last name
    Name string
    Name of the IDP
    NickNameAttribute string
    User attribute for the nick name
    PhoneAttribute string
    User attribute for the phone
    PhoneVerifiedAttribute string
    User attribute for the phone verified state
    PreferredLanguageAttribute string
    User attribute for the preferred language
    PreferredUsernameAttribute string
    User attribute for the preferred username
    ProfileAttribute string
    User attribute for the profile
    baseDn String
    Base DN for LDAP connections
    bindDn String
    Bind DN for LDAP connections
    bindPassword String
    Bind password for LDAP connections
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    servers List<String>
    Servers to try in order for establishing LDAP connections
    startTls Boolean
    Wether to use StartTLS for LDAP connections
    timeout String
    Timeout for LDAP connections
    userBase String
    User base for LDAP connections
    userFilters List<String>
    User filters for LDAP connections
    userObjectClasses List<String>
    User object classes for LDAP connections
    avatarUrlAttribute String
    User attribute for the avatar url
    displayNameAttribute String
    User attribute for the display name
    emailAttribute String
    User attribute for the email
    emailVerifiedAttribute String
    User attribute for the email verified state
    firstNameAttribute String
    User attribute for the first name
    idAttribute String
    User attribute for the id
    lastNameAttribute String
    User attribute for the last name
    name String
    Name of the IDP
    nickNameAttribute String
    User attribute for the nick name
    phoneAttribute String
    User attribute for the phone
    phoneVerifiedAttribute String
    User attribute for the phone verified state
    preferredLanguageAttribute String
    User attribute for the preferred language
    preferredUsernameAttribute String
    User attribute for the preferred username
    profileAttribute String
    User attribute for the profile
    baseDn string
    Base DN for LDAP connections
    bindDn string
    Bind DN for LDAP connections
    bindPassword string
    Bind password for LDAP connections
    isAutoCreation boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    servers string[]
    Servers to try in order for establishing LDAP connections
    startTls boolean
    Wether to use StartTLS for LDAP connections
    timeout string
    Timeout for LDAP connections
    userBase string
    User base for LDAP connections
    userFilters string[]
    User filters for LDAP connections
    userObjectClasses string[]
    User object classes for LDAP connections
    avatarUrlAttribute string
    User attribute for the avatar url
    displayNameAttribute string
    User attribute for the display name
    emailAttribute string
    User attribute for the email
    emailVerifiedAttribute string
    User attribute for the email verified state
    firstNameAttribute string
    User attribute for the first name
    idAttribute string
    User attribute for the id
    lastNameAttribute string
    User attribute for the last name
    name string
    Name of the IDP
    nickNameAttribute string
    User attribute for the nick name
    phoneAttribute string
    User attribute for the phone
    phoneVerifiedAttribute string
    User attribute for the phone verified state
    preferredLanguageAttribute string
    User attribute for the preferred language
    preferredUsernameAttribute string
    User attribute for the preferred username
    profileAttribute string
    User attribute for the profile
    base_dn str
    Base DN for LDAP connections
    bind_dn str
    Bind DN for LDAP connections
    bind_password str
    Bind password for LDAP connections
    is_auto_creation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    is_auto_update bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    is_creation_allowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    servers Sequence[str]
    Servers to try in order for establishing LDAP connections
    start_tls bool
    Wether to use StartTLS for LDAP connections
    timeout str
    Timeout for LDAP connections
    user_base str
    User base for LDAP connections
    user_filters Sequence[str]
    User filters for LDAP connections
    user_object_classes Sequence[str]
    User object classes for LDAP connections
    avatar_url_attribute str
    User attribute for the avatar url
    display_name_attribute str
    User attribute for the display name
    email_attribute str
    User attribute for the email
    email_verified_attribute str
    User attribute for the email verified state
    first_name_attribute str
    User attribute for the first name
    id_attribute str
    User attribute for the id
    last_name_attribute str
    User attribute for the last name
    name str
    Name of the IDP
    nick_name_attribute str
    User attribute for the nick name
    phone_attribute str
    User attribute for the phone
    phone_verified_attribute str
    User attribute for the phone verified state
    preferred_language_attribute str
    User attribute for the preferred language
    preferred_username_attribute str
    User attribute for the preferred username
    profile_attribute str
    User attribute for the profile
    baseDn String
    Base DN for LDAP connections
    bindDn String
    Bind DN for LDAP connections
    bindPassword String
    Bind password for LDAP connections
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    servers List<String>
    Servers to try in order for establishing LDAP connections
    startTls Boolean
    Wether to use StartTLS for LDAP connections
    timeout String
    Timeout for LDAP connections
    userBase String
    User base for LDAP connections
    userFilters List<String>
    User filters for LDAP connections
    userObjectClasses List<String>
    User object classes for LDAP connections
    avatarUrlAttribute String
    User attribute for the avatar url
    displayNameAttribute String
    User attribute for the display name
    emailAttribute String
    User attribute for the email
    emailVerifiedAttribute String
    User attribute for the email verified state
    firstNameAttribute String
    User attribute for the first name
    idAttribute String
    User attribute for the id
    lastNameAttribute String
    User attribute for the last name
    name String
    Name of the IDP
    nickNameAttribute String
    User attribute for the nick name
    phoneAttribute String
    User attribute for the phone
    phoneVerifiedAttribute String
    User attribute for the phone verified state
    preferredLanguageAttribute String
    User attribute for the preferred language
    preferredUsernameAttribute String
    User attribute for the preferred username
    profileAttribute String
    User attribute for the profile

    Outputs

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

    Get an existing IdpLdap 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?: IdpLdapState, opts?: CustomResourceOptions): IdpLdap
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        avatar_url_attribute: Optional[str] = None,
        base_dn: Optional[str] = None,
        bind_dn: Optional[str] = None,
        bind_password: Optional[str] = None,
        display_name_attribute: Optional[str] = None,
        email_attribute: Optional[str] = None,
        email_verified_attribute: Optional[str] = None,
        first_name_attribute: Optional[str] = None,
        id_attribute: Optional[str] = None,
        is_auto_creation: Optional[bool] = None,
        is_auto_update: Optional[bool] = None,
        is_creation_allowed: Optional[bool] = None,
        is_linking_allowed: Optional[bool] = None,
        last_name_attribute: Optional[str] = None,
        name: Optional[str] = None,
        nick_name_attribute: Optional[str] = None,
        phone_attribute: Optional[str] = None,
        phone_verified_attribute: Optional[str] = None,
        preferred_language_attribute: Optional[str] = None,
        preferred_username_attribute: Optional[str] = None,
        profile_attribute: Optional[str] = None,
        servers: Optional[Sequence[str]] = None,
        start_tls: Optional[bool] = None,
        timeout: Optional[str] = None,
        user_base: Optional[str] = None,
        user_filters: Optional[Sequence[str]] = None,
        user_object_classes: Optional[Sequence[str]] = None) -> IdpLdap
    func GetIdpLdap(ctx *Context, name string, id IDInput, state *IdpLdapState, opts ...ResourceOption) (*IdpLdap, error)
    public static IdpLdap Get(string name, Input<string> id, IdpLdapState? state, CustomResourceOptions? opts = null)
    public static IdpLdap get(String name, Output<String> id, IdpLdapState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AvatarUrlAttribute string
    User attribute for the avatar url
    BaseDn string
    Base DN for LDAP connections
    BindDn string
    Bind DN for LDAP connections
    BindPassword string
    Bind password for LDAP connections
    DisplayNameAttribute string
    User attribute for the display name
    EmailAttribute string
    User attribute for the email
    EmailVerifiedAttribute string
    User attribute for the email verified state
    FirstNameAttribute string
    User attribute for the first name
    IdAttribute string
    User attribute for the id
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    LastNameAttribute string
    User attribute for the last name
    Name string
    Name of the IDP
    NickNameAttribute string
    User attribute for the nick name
    PhoneAttribute string
    User attribute for the phone
    PhoneVerifiedAttribute string
    User attribute for the phone verified state
    PreferredLanguageAttribute string
    User attribute for the preferred language
    PreferredUsernameAttribute string
    User attribute for the preferred username
    ProfileAttribute string
    User attribute for the profile
    Servers List<string>
    Servers to try in order for establishing LDAP connections
    StartTls bool
    Wether to use StartTLS for LDAP connections
    Timeout string
    Timeout for LDAP connections
    UserBase string
    User base for LDAP connections
    UserFilters List<string>
    User filters for LDAP connections
    UserObjectClasses List<string>
    User object classes for LDAP connections
    AvatarUrlAttribute string
    User attribute for the avatar url
    BaseDn string
    Base DN for LDAP connections
    BindDn string
    Bind DN for LDAP connections
    BindPassword string
    Bind password for LDAP connections
    DisplayNameAttribute string
    User attribute for the display name
    EmailAttribute string
    User attribute for the email
    EmailVerifiedAttribute string
    User attribute for the email verified state
    FirstNameAttribute string
    User attribute for the first name
    IdAttribute string
    User attribute for the id
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    LastNameAttribute string
    User attribute for the last name
    Name string
    Name of the IDP
    NickNameAttribute string
    User attribute for the nick name
    PhoneAttribute string
    User attribute for the phone
    PhoneVerifiedAttribute string
    User attribute for the phone verified state
    PreferredLanguageAttribute string
    User attribute for the preferred language
    PreferredUsernameAttribute string
    User attribute for the preferred username
    ProfileAttribute string
    User attribute for the profile
    Servers []string
    Servers to try in order for establishing LDAP connections
    StartTls bool
    Wether to use StartTLS for LDAP connections
    Timeout string
    Timeout for LDAP connections
    UserBase string
    User base for LDAP connections
    UserFilters []string
    User filters for LDAP connections
    UserObjectClasses []string
    User object classes for LDAP connections
    avatarUrlAttribute String
    User attribute for the avatar url
    baseDn String
    Base DN for LDAP connections
    bindDn String
    Bind DN for LDAP connections
    bindPassword String
    Bind password for LDAP connections
    displayNameAttribute String
    User attribute for the display name
    emailAttribute String
    User attribute for the email
    emailVerifiedAttribute String
    User attribute for the email verified state
    firstNameAttribute String
    User attribute for the first name
    idAttribute String
    User attribute for the id
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    lastNameAttribute String
    User attribute for the last name
    name String
    Name of the IDP
    nickNameAttribute String
    User attribute for the nick name
    phoneAttribute String
    User attribute for the phone
    phoneVerifiedAttribute String
    User attribute for the phone verified state
    preferredLanguageAttribute String
    User attribute for the preferred language
    preferredUsernameAttribute String
    User attribute for the preferred username
    profileAttribute String
    User attribute for the profile
    servers List<String>
    Servers to try in order for establishing LDAP connections
    startTls Boolean
    Wether to use StartTLS for LDAP connections
    timeout String
    Timeout for LDAP connections
    userBase String
    User base for LDAP connections
    userFilters List<String>
    User filters for LDAP connections
    userObjectClasses List<String>
    User object classes for LDAP connections
    avatarUrlAttribute string
    User attribute for the avatar url
    baseDn string
    Base DN for LDAP connections
    bindDn string
    Bind DN for LDAP connections
    bindPassword string
    Bind password for LDAP connections
    displayNameAttribute string
    User attribute for the display name
    emailAttribute string
    User attribute for the email
    emailVerifiedAttribute string
    User attribute for the email verified state
    firstNameAttribute string
    User attribute for the first name
    idAttribute string
    User attribute for the id
    isAutoCreation boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    lastNameAttribute string
    User attribute for the last name
    name string
    Name of the IDP
    nickNameAttribute string
    User attribute for the nick name
    phoneAttribute string
    User attribute for the phone
    phoneVerifiedAttribute string
    User attribute for the phone verified state
    preferredLanguageAttribute string
    User attribute for the preferred language
    preferredUsernameAttribute string
    User attribute for the preferred username
    profileAttribute string
    User attribute for the profile
    servers string[]
    Servers to try in order for establishing LDAP connections
    startTls boolean
    Wether to use StartTLS for LDAP connections
    timeout string
    Timeout for LDAP connections
    userBase string
    User base for LDAP connections
    userFilters string[]
    User filters for LDAP connections
    userObjectClasses string[]
    User object classes for LDAP connections
    avatar_url_attribute str
    User attribute for the avatar url
    base_dn str
    Base DN for LDAP connections
    bind_dn str
    Bind DN for LDAP connections
    bind_password str
    Bind password for LDAP connections
    display_name_attribute str
    User attribute for the display name
    email_attribute str
    User attribute for the email
    email_verified_attribute str
    User attribute for the email verified state
    first_name_attribute str
    User attribute for the first name
    id_attribute str
    User attribute for the id
    is_auto_creation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    is_auto_update bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    is_creation_allowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    last_name_attribute str
    User attribute for the last name
    name str
    Name of the IDP
    nick_name_attribute str
    User attribute for the nick name
    phone_attribute str
    User attribute for the phone
    phone_verified_attribute str
    User attribute for the phone verified state
    preferred_language_attribute str
    User attribute for the preferred language
    preferred_username_attribute str
    User attribute for the preferred username
    profile_attribute str
    User attribute for the profile
    servers Sequence[str]
    Servers to try in order for establishing LDAP connections
    start_tls bool
    Wether to use StartTLS for LDAP connections
    timeout str
    Timeout for LDAP connections
    user_base str
    User base for LDAP connections
    user_filters Sequence[str]
    User filters for LDAP connections
    user_object_classes Sequence[str]
    User object classes for LDAP connections
    avatarUrlAttribute String
    User attribute for the avatar url
    baseDn String
    Base DN for LDAP connections
    bindDn String
    Bind DN for LDAP connections
    bindPassword String
    Bind password for LDAP connections
    displayNameAttribute String
    User attribute for the display name
    emailAttribute String
    User attribute for the email
    emailVerifiedAttribute String
    User attribute for the email verified state
    firstNameAttribute String
    User attribute for the first name
    idAttribute String
    User attribute for the id
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    lastNameAttribute String
    User attribute for the last name
    name String
    Name of the IDP
    nickNameAttribute String
    User attribute for the nick name
    phoneAttribute String
    User attribute for the phone
    phoneVerifiedAttribute String
    User attribute for the phone verified state
    preferredLanguageAttribute String
    User attribute for the preferred language
    preferredUsernameAttribute String
    User attribute for the preferred username
    profileAttribute String
    User attribute for the profile
    servers List<String>
    Servers to try in order for establishing LDAP connections
    startTls Boolean
    Wether to use StartTLS for LDAP connections
    timeout String
    Timeout for LDAP connections
    userBase String
    User base for LDAP connections
    userFilters List<String>
    User filters for LDAP connections
    userObjectClasses List<String>
    User object classes for LDAP connections

    Import

    terraform The resource can be imported using the ID format <id[:bind_password]>, e.g.

     $ pulumi import zitadel:index/idpLdap:IdpLdap imported '123456789012345678:b1nd_p4ssw0rd'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-zitadel