zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
zitadel.getIdpLdap
Explore with Pulumi AI
Datasource representing an LDAP IDP on the instance.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumi.Zitadel;
return await Deployment.RunAsync(() => 
{
    var @default = Zitadel.GetIdpLdap.Invoke(new()
    {
        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.LookupIdpLdap(ctx, &zitadel.LookupIdpLdapArgs{
			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.GetIdpLdapArgs;
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.getIdpLdap(GetIdpLdapArgs.builder()
            .id("123456789012345678")
            .build());
    }
}
import pulumi
import pulumi_zitadel as zitadel
default = zitadel.get_idp_ldap(id="123456789012345678")
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumi/zitadel";
const default = zitadel.getIdpLdap({
    id: "123456789012345678",
});
variables:
  default:
    fn::invoke:
      Function: zitadel:getIdpLdap
      Arguments:
        id: '123456789012345678'
Using getIdpLdap
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 getIdpLdap(args: GetIdpLdapArgs, opts?: InvokeOptions): Promise<GetIdpLdapResult>
function getIdpLdapOutput(args: GetIdpLdapOutputArgs, opts?: InvokeOptions): Output<GetIdpLdapResult>def get_idp_ldap(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetIdpLdapResult
def get_idp_ldap_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetIdpLdapResult]func LookupIdpLdap(ctx *Context, args *LookupIdpLdapArgs, opts ...InvokeOption) (*LookupIdpLdapResult, error)
func LookupIdpLdapOutput(ctx *Context, args *LookupIdpLdapOutputArgs, opts ...InvokeOption) LookupIdpLdapResultOutput> Note: This function is named LookupIdpLdap in the Go SDK.
public static class GetIdpLdap 
{
    public static Task<GetIdpLdapResult> InvokeAsync(GetIdpLdapArgs args, InvokeOptions? opts = null)
    public static Output<GetIdpLdapResult> Invoke(GetIdpLdapInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetIdpLdapResult> getIdpLdap(GetIdpLdapArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: zitadel:index/getIdpLdap:getIdpLdap
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Id string
 - The ID of this resource.
 
- Id string
 - The ID of this resource.
 
- id String
 - The ID of this resource.
 
- id string
 - The ID of this resource.
 
- id str
 - The ID of this resource.
 
- id String
 - The ID of this resource.
 
getIdpLdap Result
The following output properties are available:
- Avatar
Url stringAttribute  - User attribute for the avatar url
 - Base
Dn string - Base DN for LDAP connections
 - Bind
Dn string - Bind DN for LDAP connections
 - Bind
Password string - Bind password for LDAP connections
 - Display
Name stringAttribute  - User attribute for the display name
 - Email
Attribute string - User attribute for the email
 - Email
Verified stringAttribute  - User attribute for the email verified state
 - First
Name stringAttribute  - User attribute for the first name
 - Id string
 - The ID of this resource.
 - Id
Attribute string - User attribute for the id
 - Is
Auto boolCreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - Is
Auto boolUpdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - Is
Creation boolAllowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - Is
Linking boolAllowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - Last
Name stringAttribute  - User attribute for the last name
 - Name string
 - Name of the IDP
 - Nick
Name stringAttribute  - User attribute for the nick name
 - Phone
Attribute string - User attribute for the phone
 - Phone
Verified stringAttribute  - User attribute for the phone verified state
 - Preferred
Language stringAttribute  - User attribute for the preferred language
 - Preferred
Username stringAttribute  - User attribute for the preferred username
 - Profile
Attribute string - User attribute for the profile
 - Servers List<string>
 - Servers to try in order for establishing LDAP connections
 - Start
Tls bool - Wether to use StartTLS for LDAP connections
 - Timeout string
 - Timeout for LDAP connections
 - User
Base string - User base for LDAP connections
 - User
Filters List<string> - User filters for LDAP connections
 - User
Object List<string>Classes  - User object classes for LDAP connections
 
- Avatar
Url stringAttribute  - User attribute for the avatar url
 - Base
Dn string - Base DN for LDAP connections
 - Bind
Dn string - Bind DN for LDAP connections
 - Bind
Password string - Bind password for LDAP connections
 - Display
Name stringAttribute  - User attribute for the display name
 - Email
Attribute string - User attribute for the email
 - Email
Verified stringAttribute  - User attribute for the email verified state
 - First
Name stringAttribute  - User attribute for the first name
 - Id string
 - The ID of this resource.
 - Id
Attribute string - User attribute for the id
 - Is
Auto boolCreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - Is
Auto boolUpdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - Is
Creation boolAllowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - Is
Linking boolAllowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - Last
Name stringAttribute  - User attribute for the last name
 - Name string
 - Name of the IDP
 - Nick
Name stringAttribute  - User attribute for the nick name
 - Phone
Attribute string - User attribute for the phone
 - Phone
Verified stringAttribute  - User attribute for the phone verified state
 - Preferred
Language stringAttribute  - User attribute for the preferred language
 - Preferred
Username stringAttribute  - User attribute for the preferred username
 - Profile
Attribute string - User attribute for the profile
 - Servers []string
 - Servers to try in order for establishing LDAP connections
 - Start
Tls bool - Wether to use StartTLS for LDAP connections
 - Timeout string
 - Timeout for LDAP connections
 - User
Base string - User base for LDAP connections
 - User
Filters []string - User filters for LDAP connections
 - User
Object []stringClasses  - User object classes for LDAP connections
 
- avatar
Url StringAttribute  - User attribute for the avatar url
 - base
Dn String - Base DN for LDAP connections
 - bind
Dn String - Bind DN for LDAP connections
 - bind
Password String - Bind password for LDAP connections
 - display
Name StringAttribute  - User attribute for the display name
 - email
Attribute String - User attribute for the email
 - email
Verified StringAttribute  - User attribute for the email verified state
 - first
Name StringAttribute  - User attribute for the first name
 - id String
 - The ID of this resource.
 - id
Attribute String - User attribute for the id
 - is
Auto BooleanCreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - is
Auto BooleanUpdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - is
Creation BooleanAllowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - is
Linking BooleanAllowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - last
Name StringAttribute  - User attribute for the last name
 - name String
 - Name of the IDP
 - nick
Name StringAttribute  - User attribute for the nick name
 - phone
Attribute String - User attribute for the phone
 - phone
Verified StringAttribute  - User attribute for the phone verified state
 - preferred
Language StringAttribute  - User attribute for the preferred language
 - preferred
Username StringAttribute  - User attribute for the preferred username
 - profile
Attribute String - User attribute for the profile
 - servers List<String>
 - Servers to try in order for establishing LDAP connections
 - start
Tls Boolean - Wether to use StartTLS for LDAP connections
 - timeout String
 - Timeout for LDAP connections
 - user
Base String - User base for LDAP connections
 - user
Filters List<String> - User filters for LDAP connections
 - user
Object List<String>Classes  - User object classes for LDAP connections
 
- avatar
Url stringAttribute  - User attribute for the avatar url
 - base
Dn string - Base DN for LDAP connections
 - bind
Dn string - Bind DN for LDAP connections
 - bind
Password string - Bind password for LDAP connections
 - display
Name stringAttribute  - User attribute for the display name
 - email
Attribute string - User attribute for the email
 - email
Verified stringAttribute  - User attribute for the email verified state
 - first
Name stringAttribute  - User attribute for the first name
 - id string
 - The ID of this resource.
 - id
Attribute string - User attribute for the id
 - is
Auto booleanCreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - is
Auto booleanUpdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - is
Creation booleanAllowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - is
Linking booleanAllowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - last
Name stringAttribute  - User attribute for the last name
 - name string
 - Name of the IDP
 - nick
Name stringAttribute  - User attribute for the nick name
 - phone
Attribute string - User attribute for the phone
 - phone
Verified stringAttribute  - User attribute for the phone verified state
 - preferred
Language stringAttribute  - User attribute for the preferred language
 - preferred
Username stringAttribute  - User attribute for the preferred username
 - profile
Attribute string - User attribute for the profile
 - servers string[]
 - Servers to try in order for establishing LDAP connections
 - start
Tls boolean - Wether to use StartTLS for LDAP connections
 - timeout string
 - Timeout for LDAP connections
 - user
Base string - User base for LDAP connections
 - user
Filters string[] - User filters for LDAP connections
 - user
Object string[]Classes  - User object classes for LDAP connections
 
- avatar_
url_ strattribute  - 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_ strattribute  - User attribute for the display name
 - email_
attribute str - User attribute for the email
 - email_
verified_ strattribute  - User attribute for the email verified state
 - first_
name_ strattribute  - User attribute for the first name
 - id str
 - The ID of this resource.
 - id_
attribute str - User attribute for the id
 - is_
auto_ boolcreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - is_
auto_ boolupdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - is_
creation_ boolallowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - is_
linking_ boolallowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - last_
name_ strattribute  - User attribute for the last name
 - name str
 - Name of the IDP
 - nick_
name_ strattribute  - User attribute for the nick name
 - phone_
attribute str - User attribute for the phone
 - phone_
verified_ strattribute  - User attribute for the phone verified state
 - preferred_
language_ strattribute  - User attribute for the preferred language
 - preferred_
username_ strattribute  - 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_ Sequence[str]classes  - User object classes for LDAP connections
 
- avatar
Url StringAttribute  - User attribute for the avatar url
 - base
Dn String - Base DN for LDAP connections
 - bind
Dn String - Bind DN for LDAP connections
 - bind
Password String - Bind password for LDAP connections
 - display
Name StringAttribute  - User attribute for the display name
 - email
Attribute String - User attribute for the email
 - email
Verified StringAttribute  - User attribute for the email verified state
 - first
Name StringAttribute  - User attribute for the first name
 - id String
 - The ID of this resource.
 - id
Attribute String - User attribute for the id
 - is
Auto BooleanCreation  - enabled if a new account in ZITADEL are created automatically on login with an external account
 - is
Auto BooleanUpdate  - enabled if a the ZITADEL account fields are updated automatically on each login
 - is
Creation BooleanAllowed  - enabled if users are able to create a new account in ZITADEL when using an external account
 - is
Linking BooleanAllowed  - enabled if users are able to link an existing ZITADEL user with an external account
 - last
Name StringAttribute  - User attribute for the last name
 - name String
 - Name of the IDP
 - nick
Name StringAttribute  - User attribute for the nick name
 - phone
Attribute String - User attribute for the phone
 - phone
Verified StringAttribute  - User attribute for the phone verified state
 - preferred
Language StringAttribute  - User attribute for the preferred language
 - preferred
Username StringAttribute  - User attribute for the preferred username
 - profile
Attribute String - User attribute for the profile
 - servers List<String>
 - Servers to try in order for establishing LDAP connections
 - start
Tls Boolean - Wether to use StartTLS for LDAP connections
 - timeout String
 - Timeout for LDAP connections
 - user
Base String - User base for LDAP connections
 - user
Filters List<String> - User filters for LDAP connections
 - user
Object List<String>Classes  - User object classes for LDAP connections
 
Package Details
- Repository
 - zitadel pulumiverse/pulumi-zitadel
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
zitadelTerraform Provider.