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

zitadel.getOrgIdpLdap

Explore with Pulumi AI

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

    Datasource representing an LDAP IdP on the organization.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumi.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Zitadel.GetOrgIdpLdap.Invoke(new()
        {
            OrgId = data.Zitadel_org.Default.Id,
            Id = "123456789012345678",
        });
    
    });
    
    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.LookupOrgIdpLdap(ctx, &zitadel.LookupOrgIdpLdapArgs{
    			OrgId: pulumi.StringRef(data.Zitadel_org.Default.Id),
    			Id:    "123456789012345678",
    		}, nil)
    		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.ZitadelFunctions;
    import com.pulumi.zitadel.inputs.GetOrgIdpLdapArgs;
    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 default = ZitadelFunctions.getOrgIdpLdap(GetOrgIdpLdapArgs.builder()
                .orgId(data.zitadel_org().default().id())
                .id("123456789012345678")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_zitadel as zitadel
    
    default = zitadel.get_org_idp_ldap(org_id=data["zitadel_org"]["default"]["id"],
        id="123456789012345678")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumi/zitadel";
    
    const default = zitadel.getOrgIdpLdap({
        orgId: data.zitadel_org["default"].id,
        id: "123456789012345678",
    });
    
    variables:
      default:
        fn::invoke:
          Function: zitadel:getOrgIdpLdap
          Arguments:
            orgId: ${data.zitadel_org.default.id}
            id: '123456789012345678'
    

    Using getOrgIdpLdap

    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 getOrgIdpLdap(args: GetOrgIdpLdapArgs, opts?: InvokeOptions): Promise<GetOrgIdpLdapResult>
    function getOrgIdpLdapOutput(args: GetOrgIdpLdapOutputArgs, opts?: InvokeOptions): Output<GetOrgIdpLdapResult>
    def get_org_idp_ldap(id: Optional[str] = None,
                         org_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOrgIdpLdapResult
    def get_org_idp_ldap_output(id: Optional[pulumi.Input[str]] = None,
                         org_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOrgIdpLdapResult]
    func LookupOrgIdpLdap(ctx *Context, args *LookupOrgIdpLdapArgs, opts ...InvokeOption) (*LookupOrgIdpLdapResult, error)
    func LookupOrgIdpLdapOutput(ctx *Context, args *LookupOrgIdpLdapOutputArgs, opts ...InvokeOption) LookupOrgIdpLdapResultOutput

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

    public static class GetOrgIdpLdap 
    {
        public static Task<GetOrgIdpLdapResult> InvokeAsync(GetOrgIdpLdapArgs args, InvokeOptions? opts = null)
        public static Output<GetOrgIdpLdapResult> Invoke(GetOrgIdpLdapInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrgIdpLdapResult> getOrgIdpLdap(GetOrgIdpLdapArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: zitadel:index/getOrgIdpLdap:getOrgIdpLdap
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    OrgId string
    ID of the organization
    Id string
    The ID of this resource.
    OrgId string
    ID of the organization
    id String
    The ID of this resource.
    orgId String
    ID of the organization
    id string
    The ID of this resource.
    orgId string
    ID of the organization
    id str
    The ID of this resource.
    org_id str
    ID of the organization
    id String
    The ID of this resource.
    orgId String
    ID of the organization

    getOrgIdpLdap Result

    The following output properties are available:

    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
    Id string
    The ID of this resource.
    IdAttribute string
    User attribute for the id
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are 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
    OrgId string
    ID of the organization
    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
    Id string
    The ID of this resource.
    IdAttribute string
    User attribute for the id
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are 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
    OrgId string
    ID of the organization
    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
    id String
    The ID of this resource.
    idAttribute String
    User attribute for the id
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are 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
    orgId String
    ID of the organization
    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
    id string
    The ID of this resource.
    idAttribute string
    User attribute for the id
    isAutoCreation boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enabled if users are 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
    orgId string
    ID of the organization
    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 str
    The ID of this resource.
    id_attribute str
    User attribute for the id
    is_auto_creation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    is_auto_update bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    is_creation_allowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enabled if users are 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
    org_id str
    ID of the organization
    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
    id String
    The ID of this resource.
    idAttribute String
    User attribute for the id
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are 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
    orgId String
    ID of the organization

    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