Docs Packages
  1. Packages
  2. Rancher2
  3. API Docs
  4. AuthConfigOpenLdap
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi
pulumi/pulumi-rancher2

rancher2.AuthConfigOpenLdap

Explore with Pulumi AI

rancher2 logo
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi
pulumi/pulumi-rancher2

    Provides a Rancher v2 Auth Config OpenLdap resource. This can be used to configure and enable Auth Config OpenLdap for Rancher v2 RKE clusters and retrieve their information.

    In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

    Create AuthConfigOpenLdap Resource

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

    Constructor syntax

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

@overload
def AuthConfigOpenLdap(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       servers: Optional[Sequence[str]] = None,
                       user_search_base: Optional[str] = None,
                       test_username: Optional[str] = None,
                       test_password: Optional[str] = None,
                       service_account_password: Optional[str] = None,
                       service_account_distinguished_name: Optional[str] = None,
                       port: Optional[int] = None,
                       connection_timeout: Optional[int] = None,
                       group_member_user_attribute: Optional[str] = None,
                       group_name_attribute: Optional[str] = None,
                       group_object_class: Optional[str] = None,
                       group_search_attribute: Optional[str] = None,
                       group_search_base: Optional[str] = None,
                       group_search_filter: Optional[str] = None,
                       labels: Optional[Mapping[str, Any]] = None,
                       nested_group_membership_enabled: Optional[bool] = None,
                       access_mode: Optional[str] = None,
                       group_dn_attribute: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       group_member_mapping_attribute: Optional[str] = None,
                       start_tls: Optional[bool] = None,
                       certificate: Optional[str] = None,
                       annotations: Optional[Mapping[str, Any]] = None,
                       tls: Optional[bool] = None,
                       user_disabled_bit_mask: Optional[int] = None,
                       user_enabled_attribute: Optional[str] = None,
                       user_login_attribute: Optional[str] = None,
                       user_member_attribute: Optional[str] = None,
                       user_name_attribute: Optional[str] = None,
                       user_object_class: Optional[str] = None,
                       user_search_attribute: Optional[str] = None,
                       allowed_principal_ids: Optional[Sequence[str]] = None,
                       user_search_filter: Optional[str] = None)
    func NewAuthConfigOpenLdap(ctx *Context, name string, args AuthConfigOpenLdapArgs, opts ...ResourceOption) (*AuthConfigOpenLdap, error)
    public AuthConfigOpenLdap(string name, AuthConfigOpenLdapArgs args, CustomResourceOptions? opts = null)
    public AuthConfigOpenLdap(String name, AuthConfigOpenLdapArgs args)
public AuthConfigOpenLdap(String name, AuthConfigOpenLdapArgs args, CustomResourceOptions options)

    type: rancher2:AuthConfigOpenLdap
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 AuthConfigOpenLdapArgs
    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 AuthConfigOpenLdapArgs
    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 AuthConfigOpenLdapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthConfigOpenLdapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthConfigOpenLdapArgs
    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 authConfigOpenLdapResource = new Rancher2.AuthConfigOpenLdap("authConfigOpenLdapResource", new()
{
    Servers = new[]
    {
        "string",
    },
    UserSearchBase = "string",
    TestUsername = "string",
    TestPassword = "string",
    ServiceAccountPassword = "string",
    ServiceAccountDistinguishedName = "string",
    Port = 0,
    ConnectionTimeout = 0,
    GroupMemberUserAttribute = "string",
    GroupNameAttribute = "string",
    GroupObjectClass = "string",
    GroupSearchAttribute = "string",
    GroupSearchBase = "string",
    GroupSearchFilter = "string",
    Labels = 
    {
        { "string", "any" },
    },
    NestedGroupMembershipEnabled = false,
    AccessMode = "string",
    GroupDnAttribute = "string",
    Enabled = false,
    GroupMemberMappingAttribute = "string",
    StartTls = false,
    Certificate = "string",
    Annotations = 
    {
        { "string", "any" },
    },
    Tls = false,
    UserDisabledBitMask = 0,
    UserEnabledAttribute = "string",
    UserLoginAttribute = "string",
    UserMemberAttribute = "string",
    UserNameAttribute = "string",
    UserObjectClass = "string",
    UserSearchAttribute = "string",
    AllowedPrincipalIds = new[]
    {
        "string",
    },
    UserSearchFilter = "string",
});

    example, err := rancher2.NewAuthConfigOpenLdap(ctx, "authConfigOpenLdapResource", &rancher2.AuthConfigOpenLdapArgs{
	Servers: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserSearchBase:                  pulumi.String("string"),
	TestUsername:                    pulumi.String("string"),
	TestPassword:                    pulumi.String("string"),
	ServiceAccountPassword:          pulumi.String("string"),
	ServiceAccountDistinguishedName: pulumi.String("string"),
	Port:                            pulumi.Int(0),
	ConnectionTimeout:               pulumi.Int(0),
	GroupMemberUserAttribute:        pulumi.String("string"),
	GroupNameAttribute:              pulumi.String("string"),
	GroupObjectClass:                pulumi.String("string"),
	GroupSearchAttribute:            pulumi.String("string"),
	GroupSearchBase:                 pulumi.String("string"),
	GroupSearchFilter:               pulumi.String("string"),
	Labels: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	NestedGroupMembershipEnabled: pulumi.Bool(false),
	AccessMode:                   pulumi.String("string"),
	GroupDnAttribute:             pulumi.String("string"),
	Enabled:                      pulumi.Bool(false),
	GroupMemberMappingAttribute:  pulumi.String("string"),
	StartTls:                     pulumi.Bool(false),
	Certificate:                  pulumi.String("string"),
	Annotations: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Tls:                  pulumi.Bool(false),
	UserDisabledBitMask:  pulumi.Int(0),
	UserEnabledAttribute: pulumi.String("string"),
	UserLoginAttribute:   pulumi.String("string"),
	UserMemberAttribute:  pulumi.String("string"),
	UserNameAttribute:    pulumi.String("string"),
	UserObjectClass:      pulumi.String("string"),
	UserSearchAttribute:  pulumi.String("string"),
	AllowedPrincipalIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserSearchFilter: pulumi.String("string"),
})

    var authConfigOpenLdapResource = new AuthConfigOpenLdap("authConfigOpenLdapResource", AuthConfigOpenLdapArgs.builder()        
    .servers("string")
    .userSearchBase("string")
    .testUsername("string")
    .testPassword("string")
    .serviceAccountPassword("string")
    .serviceAccountDistinguishedName("string")
    .port(0)
    .connectionTimeout(0)
    .groupMemberUserAttribute("string")
    .groupNameAttribute("string")
    .groupObjectClass("string")
    .groupSearchAttribute("string")
    .groupSearchBase("string")
    .groupSearchFilter("string")
    .labels(Map.of("string", "any"))
    .nestedGroupMembershipEnabled(false)
    .accessMode("string")
    .groupDnAttribute("string")
    .enabled(false)
    .groupMemberMappingAttribute("string")
    .startTls(false)
    .certificate("string")
    .annotations(Map.of("string", "any"))
    .tls(false)
    .userDisabledBitMask(0)
    .userEnabledAttribute("string")
    .userLoginAttribute("string")
    .userMemberAttribute("string")
    .userNameAttribute("string")
    .userObjectClass("string")
    .userSearchAttribute("string")
    .allowedPrincipalIds("string")
    .userSearchFilter("string")
    .build());

    auth_config_open_ldap_resource = rancher2.AuthConfigOpenLdap("authConfigOpenLdapResource",
    servers=["string"],
    user_search_base="string",
    test_username="string",
    test_password="string",
    service_account_password="string",
    service_account_distinguished_name="string",
    port=0,
    connection_timeout=0,
    group_member_user_attribute="string",
    group_name_attribute="string",
    group_object_class="string",
    group_search_attribute="string",
    group_search_base="string",
    group_search_filter="string",
    labels={
        "string": "any",
    },
    nested_group_membership_enabled=False,
    access_mode="string",
    group_dn_attribute="string",
    enabled=False,
    group_member_mapping_attribute="string",
    start_tls=False,
    certificate="string",
    annotations={
        "string": "any",
    },
    tls=False,
    user_disabled_bit_mask=0,
    user_enabled_attribute="string",
    user_login_attribute="string",
    user_member_attribute="string",
    user_name_attribute="string",
    user_object_class="string",
    user_search_attribute="string",
    allowed_principal_ids=["string"],
    user_search_filter="string")

    const authConfigOpenLdapResource = new rancher2.AuthConfigOpenLdap("authConfigOpenLdapResource", {
    servers: ["string"],
    userSearchBase: "string",
    testUsername: "string",
    testPassword: "string",
    serviceAccountPassword: "string",
    serviceAccountDistinguishedName: "string",
    port: 0,
    connectionTimeout: 0,
    groupMemberUserAttribute: "string",
    groupNameAttribute: "string",
    groupObjectClass: "string",
    groupSearchAttribute: "string",
    groupSearchBase: "string",
    groupSearchFilter: "string",
    labels: {
        string: "any",
    },
    nestedGroupMembershipEnabled: false,
    accessMode: "string",
    groupDnAttribute: "string",
    enabled: false,
    groupMemberMappingAttribute: "string",
    startTls: false,
    certificate: "string",
    annotations: {
        string: "any",
    },
    tls: false,
    userDisabledBitMask: 0,
    userEnabledAttribute: "string",
    userLoginAttribute: "string",
    userMemberAttribute: "string",
    userNameAttribute: "string",
    userObjectClass: "string",
    userSearchAttribute: "string",
    allowedPrincipalIds: ["string"],
    userSearchFilter: "string",
});

    type: rancher2:AuthConfigOpenLdap
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: any
    certificate: string
    connectionTimeout: 0
    enabled: false
    groupDnAttribute: string
    groupMemberMappingAttribute: string
    groupMemberUserAttribute: string
    groupNameAttribute: string
    groupObjectClass: string
    groupSearchAttribute: string
    groupSearchBase: string
    groupSearchFilter: string
    labels:
        string: any
    nestedGroupMembershipEnabled: false
    port: 0
    servers:
        - string
    serviceAccountDistinguishedName: string
    serviceAccountPassword: string
    startTls: false
    testPassword: string
    testUsername: string
    tls: false
    userDisabledBitMask: 0
    userEnabledAttribute: string
    userLoginAttribute: string
    userMemberAttribute: string
    userNameAttribute: string
    userObjectClass: string
    userSearchAttribute: string
    userSearchBase: string
    userSearchFilter: string

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

    Servers List<string>
    OpenLdap servers list (list)
    ServiceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    ServiceAccountPassword string
    Service account password for access OpenLdap service (string)
    TestPassword string
    Password for test access to OpenLdap service (string)
    TestUsername string
    Username for test access to OpenLdap service (string)
    UserSearchBase string
    User search base DN (string)
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds List<string>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    Annotations Dictionary<string, object>
    Annotations of the resource (map)
    Certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    ConnectionTimeout int
    OpenLdap connection timeout. Default 5000 (int)
    Enabled bool
    Enable auth config provider. Default true (bool)
    GroupDnAttribute string
    Group DN attribute. Default entryDN (string)
    GroupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    GroupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    GroupNameAttribute string
    Group name attribute. Default cn (string)
    GroupObjectClass string
    Group object class. Default groupOfNames (string)
    GroupSearchAttribute string
    Group search attribute. Default cn (string)
    GroupSearchBase string
    Group search base (string)
    GroupSearchFilter string
    Labels Dictionary<string, object>
    Labels of the resource (map)
    NestedGroupMembershipEnabled bool
    Nested group membership enable. Default false (bool)
    Port int
    OpenLdap port. Default 389 (int)
    StartTls bool
    Tls bool
    Enable TLS connection (bool)
    UserDisabledBitMask int
    User disabled bit mask (int)
    UserEnabledAttribute string
    User enable attribute (string)
    UserLoginAttribute string
    User login attribute. Default uid (string)
    UserMemberAttribute string
    User member attribute. Default memberOf (string)
    UserNameAttribute string
    User name attribute. Default givenName (string)
    UserObjectClass string
    User object class. Default inetorgperson (string)
    UserSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    UserSearchFilter string
    Servers []string
    OpenLdap servers list (list)
    ServiceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    ServiceAccountPassword string
    Service account password for access OpenLdap service (string)
    TestPassword string
    Password for test access to OpenLdap service (string)
    TestUsername string
    Username for test access to OpenLdap service (string)
    UserSearchBase string
    User search base DN (string)
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds []string
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    Annotations map[string]interface{}
    Annotations of the resource (map)
    Certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    ConnectionTimeout int
    OpenLdap connection timeout. Default 5000 (int)
    Enabled bool
    Enable auth config provider. Default true (bool)
    GroupDnAttribute string
    Group DN attribute. Default entryDN (string)
    GroupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    GroupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    GroupNameAttribute string
    Group name attribute. Default cn (string)
    GroupObjectClass string
    Group object class. Default groupOfNames (string)
    GroupSearchAttribute string
    Group search attribute. Default cn (string)
    GroupSearchBase string
    Group search base (string)
    GroupSearchFilter string
    Labels map[string]interface{}
    Labels of the resource (map)
    NestedGroupMembershipEnabled bool
    Nested group membership enable. Default false (bool)
    Port int
    OpenLdap port. Default 389 (int)
    StartTls bool
    Tls bool
    Enable TLS connection (bool)
    UserDisabledBitMask int
    User disabled bit mask (int)
    UserEnabledAttribute string
    User enable attribute (string)
    UserLoginAttribute string
    User login attribute. Default uid (string)
    UserMemberAttribute string
    User member attribute. Default memberOf (string)
    UserNameAttribute string
    User name attribute. Default givenName (string)
    UserObjectClass string
    User object class. Default inetorgperson (string)
    UserSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    UserSearchFilter string
    servers List<String>
    OpenLdap servers list (list)
    serviceAccountDistinguishedName String
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword String
    Service account password for access OpenLdap service (string)
    testPassword String
    Password for test access to OpenLdap service (string)
    testUsername String
    Username for test access to OpenLdap service (string)
    userSearchBase String
    User search base DN (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Map<String,Object>
    Annotations of the resource (map)
    certificate String
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout Integer
    OpenLdap connection timeout. Default 5000 (int)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute String
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute String
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute String
    Group member user attribute. Default entryDN (string)
    groupNameAttribute String
    Group name attribute. Default cn (string)
    groupObjectClass String
    Group object class. Default groupOfNames (string)
    groupSearchAttribute String
    Group search attribute. Default cn (string)
    groupSearchBase String
    Group search base (string)
    groupSearchFilter String
    labels Map<String,Object>
    Labels of the resource (map)
    nestedGroupMembershipEnabled Boolean
    Nested group membership enable. Default false (bool)
    port Integer
    OpenLdap port. Default 389 (int)
    startTls Boolean
    tls Boolean
    Enable TLS connection (bool)
    userDisabledBitMask Integer
    User disabled bit mask (int)
    userEnabledAttribute String
    User enable attribute (string)
    userLoginAttribute String
    User login attribute. Default uid (string)
    userMemberAttribute String
    User member attribute. Default memberOf (string)
    userNameAttribute String
    User name attribute. Default givenName (string)
    userObjectClass String
    User object class. Default inetorgperson (string)
    userSearchAttribute String
    User search attribute. Default uid|sn|givenName (string)
    userSearchFilter String
    servers string[]
    OpenLdap servers list (list)
    serviceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword string
    Service account password for access OpenLdap service (string)
    testPassword string
    Password for test access to OpenLdap service (string)
    testUsername string
    Username for test access to OpenLdap service (string)
    userSearchBase string
    User search base DN (string)
    accessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds string[]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations {[key: string]: any}
    Annotations of the resource (map)
    certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout number
    OpenLdap connection timeout. Default 5000 (int)
    enabled boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute string
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    groupNameAttribute string
    Group name attribute. Default cn (string)
    groupObjectClass string
    Group object class. Default groupOfNames (string)
    groupSearchAttribute string
    Group search attribute. Default cn (string)
    groupSearchBase string
    Group search base (string)
    groupSearchFilter string
    labels {[key: string]: any}
    Labels of the resource (map)
    nestedGroupMembershipEnabled boolean
    Nested group membership enable. Default false (bool)
    port number
    OpenLdap port. Default 389 (int)
    startTls boolean
    tls boolean
    Enable TLS connection (bool)
    userDisabledBitMask number
    User disabled bit mask (int)
    userEnabledAttribute string
    User enable attribute (string)
    userLoginAttribute string
    User login attribute. Default uid (string)
    userMemberAttribute string
    User member attribute. Default memberOf (string)
    userNameAttribute string
    User name attribute. Default givenName (string)
    userObjectClass string
    User object class. Default inetorgperson (string)
    userSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    userSearchFilter string
    servers Sequence[str]
    OpenLdap servers list (list)
    service_account_distinguished_name str
    Service account DN for access OpenLdap service (string)
    service_account_password str
    Service account password for access OpenLdap service (string)
    test_password str
    Password for test access to OpenLdap service (string)
    test_username str
    Username for test access to OpenLdap service (string)
    user_search_base str
    User search base DN (string)
    access_mode str
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowed_principal_ids Sequence[str]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Mapping[str, Any]
    Annotations of the resource (map)
    certificate str
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connection_timeout int
    OpenLdap connection timeout. Default 5000 (int)
    enabled bool
    Enable auth config provider. Default true (bool)
    group_dn_attribute str
    Group DN attribute. Default entryDN (string)
    group_member_mapping_attribute str
    Group member mapping attribute. Default member (string)
    group_member_user_attribute str
    Group member user attribute. Default entryDN (string)
    group_name_attribute str
    Group name attribute. Default cn (string)
    group_object_class str
    Group object class. Default groupOfNames (string)
    group_search_attribute str
    Group search attribute. Default cn (string)
    group_search_base str
    Group search base (string)
    group_search_filter str
    labels Mapping[str, Any]
    Labels of the resource (map)
    nested_group_membership_enabled bool
    Nested group membership enable. Default false (bool)
    port int
    OpenLdap port. Default 389 (int)
    start_tls bool
    tls bool
    Enable TLS connection (bool)
    user_disabled_bit_mask int
    User disabled bit mask (int)
    user_enabled_attribute str
    User enable attribute (string)
    user_login_attribute str
    User login attribute. Default uid (string)
    user_member_attribute str
    User member attribute. Default memberOf (string)
    user_name_attribute str
    User name attribute. Default givenName (string)
    user_object_class str
    User object class. Default inetorgperson (string)
    user_search_attribute str
    User search attribute. Default uid|sn|givenName (string)
    user_search_filter str
    servers List<String>
    OpenLdap servers list (list)
    serviceAccountDistinguishedName String
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword String
    Service account password for access OpenLdap service (string)
    testPassword String
    Password for test access to OpenLdap service (string)
    testUsername String
    Username for test access to OpenLdap service (string)
    userSearchBase String
    User search base DN (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Map<Any>
    Annotations of the resource (map)
    certificate String
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout Number
    OpenLdap connection timeout. Default 5000 (int)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute String
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute String
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute String
    Group member user attribute. Default entryDN (string)
    groupNameAttribute String
    Group name attribute. Default cn (string)
    groupObjectClass String
    Group object class. Default groupOfNames (string)
    groupSearchAttribute String
    Group search attribute. Default cn (string)
    groupSearchBase String
    Group search base (string)
    groupSearchFilter String
    labels Map<Any>
    Labels of the resource (map)
    nestedGroupMembershipEnabled Boolean
    Nested group membership enable. Default false (bool)
    port Number
    OpenLdap port. Default 389 (int)
    startTls Boolean
    tls Boolean
    Enable TLS connection (bool)
    userDisabledBitMask Number
    User disabled bit mask (int)
    userEnabledAttribute String
    User enable attribute (string)
    userLoginAttribute String
    User login attribute. Default uid (string)
    userMemberAttribute String
    User member attribute. Default memberOf (string)
    userNameAttribute String
    User name attribute. Default givenName (string)
    userObjectClass String
    User object class. Default inetorgperson (string)
    userSearchAttribute String
    User search attribute. Default uid|sn|givenName (string)
    userSearchFilter String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (Computed) The name of the resource (string)
    Type string
    (Computed) The type of the resource (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (Computed) The name of the resource (string)
    Type string
    (Computed) The type of the resource (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (Computed) The name of the resource (string)
    type String
    (Computed) The type of the resource (string)
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (Computed) The name of the resource (string)
    type string
    (Computed) The type of the resource (string)
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (Computed) The name of the resource (string)
    type str
    (Computed) The type of the resource (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (Computed) The name of the resource (string)
    type String
    (Computed) The type of the resource (string)

    Look up Existing AuthConfigOpenLdap Resource

    Get an existing AuthConfigOpenLdap 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?: AuthConfigOpenLdapState, opts?: CustomResourceOptions): AuthConfigOpenLdap
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        allowed_principal_ids: Optional[Sequence[str]] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        certificate: Optional[str] = None,
        connection_timeout: Optional[int] = None,
        enabled: Optional[bool] = None,
        group_dn_attribute: Optional[str] = None,
        group_member_mapping_attribute: Optional[str] = None,
        group_member_user_attribute: Optional[str] = None,
        group_name_attribute: Optional[str] = None,
        group_object_class: Optional[str] = None,
        group_search_attribute: Optional[str] = None,
        group_search_base: Optional[str] = None,
        group_search_filter: Optional[str] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        nested_group_membership_enabled: Optional[bool] = None,
        port: Optional[int] = None,
        servers: Optional[Sequence[str]] = None,
        service_account_distinguished_name: Optional[str] = None,
        service_account_password: Optional[str] = None,
        start_tls: Optional[bool] = None,
        test_password: Optional[str] = None,
        test_username: Optional[str] = None,
        tls: Optional[bool] = None,
        type: Optional[str] = None,
        user_disabled_bit_mask: Optional[int] = None,
        user_enabled_attribute: Optional[str] = None,
        user_login_attribute: Optional[str] = None,
        user_member_attribute: Optional[str] = None,
        user_name_attribute: Optional[str] = None,
        user_object_class: Optional[str] = None,
        user_search_attribute: Optional[str] = None,
        user_search_base: Optional[str] = None,
        user_search_filter: Optional[str] = None) -> AuthConfigOpenLdap
    func GetAuthConfigOpenLdap(ctx *Context, name string, id IDInput, state *AuthConfigOpenLdapState, opts ...ResourceOption) (*AuthConfigOpenLdap, error)
    public static AuthConfigOpenLdap Get(string name, Input<string> id, AuthConfigOpenLdapState? state, CustomResourceOptions? opts = null)
    public static AuthConfigOpenLdap get(String name, Output<String> id, AuthConfigOpenLdapState 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:
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds List<string>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    Annotations Dictionary<string, object>
    Annotations of the resource (map)
    Certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    ConnectionTimeout int
    OpenLdap connection timeout. Default 5000 (int)
    Enabled bool
    Enable auth config provider. Default true (bool)
    GroupDnAttribute string
    Group DN attribute. Default entryDN (string)
    GroupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    GroupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    GroupNameAttribute string
    Group name attribute. Default cn (string)
    GroupObjectClass string
    Group object class. Default groupOfNames (string)
    GroupSearchAttribute string
    Group search attribute. Default cn (string)
    GroupSearchBase string
    Group search base (string)
    GroupSearchFilter string
    Labels Dictionary<string, object>
    Labels of the resource (map)
    Name string
    (Computed) The name of the resource (string)
    NestedGroupMembershipEnabled bool
    Nested group membership enable. Default false (bool)
    Port int
    OpenLdap port. Default 389 (int)
    Servers List<string>
    OpenLdap servers list (list)
    ServiceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    ServiceAccountPassword string
    Service account password for access OpenLdap service (string)
    StartTls bool
    TestPassword string
    Password for test access to OpenLdap service (string)
    TestUsername string
    Username for test access to OpenLdap service (string)
    Tls bool
    Enable TLS connection (bool)
    Type string
    (Computed) The type of the resource (string)
    UserDisabledBitMask int
    User disabled bit mask (int)
    UserEnabledAttribute string
    User enable attribute (string)
    UserLoginAttribute string
    User login attribute. Default uid (string)
    UserMemberAttribute string
    User member attribute. Default memberOf (string)
    UserNameAttribute string
    User name attribute. Default givenName (string)
    UserObjectClass string
    User object class. Default inetorgperson (string)
    UserSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    UserSearchBase string
    User search base DN (string)
    UserSearchFilter string
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds []string
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    Annotations map[string]interface{}
    Annotations of the resource (map)
    Certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    ConnectionTimeout int
    OpenLdap connection timeout. Default 5000 (int)
    Enabled bool
    Enable auth config provider. Default true (bool)
    GroupDnAttribute string
    Group DN attribute. Default entryDN (string)
    GroupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    GroupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    GroupNameAttribute string
    Group name attribute. Default cn (string)
    GroupObjectClass string
    Group object class. Default groupOfNames (string)
    GroupSearchAttribute string
    Group search attribute. Default cn (string)
    GroupSearchBase string
    Group search base (string)
    GroupSearchFilter string
    Labels map[string]interface{}
    Labels of the resource (map)
    Name string
    (Computed) The name of the resource (string)
    NestedGroupMembershipEnabled bool
    Nested group membership enable. Default false (bool)
    Port int
    OpenLdap port. Default 389 (int)
    Servers []string
    OpenLdap servers list (list)
    ServiceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    ServiceAccountPassword string
    Service account password for access OpenLdap service (string)
    StartTls bool
    TestPassword string
    Password for test access to OpenLdap service (string)
    TestUsername string
    Username for test access to OpenLdap service (string)
    Tls bool
    Enable TLS connection (bool)
    Type string
    (Computed) The type of the resource (string)
    UserDisabledBitMask int
    User disabled bit mask (int)
    UserEnabledAttribute string
    User enable attribute (string)
    UserLoginAttribute string
    User login attribute. Default uid (string)
    UserMemberAttribute string
    User member attribute. Default memberOf (string)
    UserNameAttribute string
    User name attribute. Default givenName (string)
    UserObjectClass string
    User object class. Default inetorgperson (string)
    UserSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    UserSearchBase string
    User search base DN (string)
    UserSearchFilter string
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Map<String,Object>
    Annotations of the resource (map)
    certificate String
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout Integer
    OpenLdap connection timeout. Default 5000 (int)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute String
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute String
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute String
    Group member user attribute. Default entryDN (string)
    groupNameAttribute String
    Group name attribute. Default cn (string)
    groupObjectClass String
    Group object class. Default groupOfNames (string)
    groupSearchAttribute String
    Group search attribute. Default cn (string)
    groupSearchBase String
    Group search base (string)
    groupSearchFilter String
    labels Map<String,Object>
    Labels of the resource (map)
    name String
    (Computed) The name of the resource (string)
    nestedGroupMembershipEnabled Boolean
    Nested group membership enable. Default false (bool)
    port Integer
    OpenLdap port. Default 389 (int)
    servers List<String>
    OpenLdap servers list (list)
    serviceAccountDistinguishedName String
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword String
    Service account password for access OpenLdap service (string)
    startTls Boolean
    testPassword String
    Password for test access to OpenLdap service (string)
    testUsername String
    Username for test access to OpenLdap service (string)
    tls Boolean
    Enable TLS connection (bool)
    type String
    (Computed) The type of the resource (string)
    userDisabledBitMask Integer
    User disabled bit mask (int)
    userEnabledAttribute String
    User enable attribute (string)
    userLoginAttribute String
    User login attribute. Default uid (string)
    userMemberAttribute String
    User member attribute. Default memberOf (string)
    userNameAttribute String
    User name attribute. Default givenName (string)
    userObjectClass String
    User object class. Default inetorgperson (string)
    userSearchAttribute String
    User search attribute. Default uid|sn|givenName (string)
    userSearchBase String
    User search base DN (string)
    userSearchFilter String
    accessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds string[]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations {[key: string]: any}
    Annotations of the resource (map)
    certificate string
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout number
    OpenLdap connection timeout. Default 5000 (int)
    enabled boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute string
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute string
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute string
    Group member user attribute. Default entryDN (string)
    groupNameAttribute string
    Group name attribute. Default cn (string)
    groupObjectClass string
    Group object class. Default groupOfNames (string)
    groupSearchAttribute string
    Group search attribute. Default cn (string)
    groupSearchBase string
    Group search base (string)
    groupSearchFilter string
    labels {[key: string]: any}
    Labels of the resource (map)
    name string
    (Computed) The name of the resource (string)
    nestedGroupMembershipEnabled boolean
    Nested group membership enable. Default false (bool)
    port number
    OpenLdap port. Default 389 (int)
    servers string[]
    OpenLdap servers list (list)
    serviceAccountDistinguishedName string
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword string
    Service account password for access OpenLdap service (string)
    startTls boolean
    testPassword string
    Password for test access to OpenLdap service (string)
    testUsername string
    Username for test access to OpenLdap service (string)
    tls boolean
    Enable TLS connection (bool)
    type string
    (Computed) The type of the resource (string)
    userDisabledBitMask number
    User disabled bit mask (int)
    userEnabledAttribute string
    User enable attribute (string)
    userLoginAttribute string
    User login attribute. Default uid (string)
    userMemberAttribute string
    User member attribute. Default memberOf (string)
    userNameAttribute string
    User name attribute. Default givenName (string)
    userObjectClass string
    User object class. Default inetorgperson (string)
    userSearchAttribute string
    User search attribute. Default uid|sn|givenName (string)
    userSearchBase string
    User search base DN (string)
    userSearchFilter string
    access_mode str
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowed_principal_ids Sequence[str]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Mapping[str, Any]
    Annotations of the resource (map)
    certificate str
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connection_timeout int
    OpenLdap connection timeout. Default 5000 (int)
    enabled bool
    Enable auth config provider. Default true (bool)
    group_dn_attribute str
    Group DN attribute. Default entryDN (string)
    group_member_mapping_attribute str
    Group member mapping attribute. Default member (string)
    group_member_user_attribute str
    Group member user attribute. Default entryDN (string)
    group_name_attribute str
    Group name attribute. Default cn (string)
    group_object_class str
    Group object class. Default groupOfNames (string)
    group_search_attribute str
    Group search attribute. Default cn (string)
    group_search_base str
    Group search base (string)
    group_search_filter str
    labels Mapping[str, Any]
    Labels of the resource (map)
    name str
    (Computed) The name of the resource (string)
    nested_group_membership_enabled bool
    Nested group membership enable. Default false (bool)
    port int
    OpenLdap port. Default 389 (int)
    servers Sequence[str]
    OpenLdap servers list (list)
    service_account_distinguished_name str
    Service account DN for access OpenLdap service (string)
    service_account_password str
    Service account password for access OpenLdap service (string)
    start_tls bool
    test_password str
    Password for test access to OpenLdap service (string)
    test_username str
    Username for test access to OpenLdap service (string)
    tls bool
    Enable TLS connection (bool)
    type str
    (Computed) The type of the resource (string)
    user_disabled_bit_mask int
    User disabled bit mask (int)
    user_enabled_attribute str
    User enable attribute (string)
    user_login_attribute str
    User login attribute. Default uid (string)
    user_member_attribute str
    User member attribute. Default memberOf (string)
    user_name_attribute str
    User name attribute. Default givenName (string)
    user_object_class str
    User object class. Default inetorgperson (string)
    user_search_attribute str
    User search attribute. Default uid|sn|givenName (string)
    user_search_base str
    User search base DN (string)
    user_search_filter str
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)
    annotations Map<Any>
    Annotations of the resource (map)
    certificate String
    Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
    connectionTimeout Number
    OpenLdap connection timeout. Default 5000 (int)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    groupDnAttribute String
    Group DN attribute. Default entryDN (string)
    groupMemberMappingAttribute String
    Group member mapping attribute. Default member (string)
    groupMemberUserAttribute String
    Group member user attribute. Default entryDN (string)
    groupNameAttribute String
    Group name attribute. Default cn (string)
    groupObjectClass String
    Group object class. Default groupOfNames (string)
    groupSearchAttribute String
    Group search attribute. Default cn (string)
    groupSearchBase String
    Group search base (string)
    groupSearchFilter String
    labels Map<Any>
    Labels of the resource (map)
    name String
    (Computed) The name of the resource (string)
    nestedGroupMembershipEnabled Boolean
    Nested group membership enable. Default false (bool)
    port Number
    OpenLdap port. Default 389 (int)
    servers List<String>
    OpenLdap servers list (list)
    serviceAccountDistinguishedName String
    Service account DN for access OpenLdap service (string)
    serviceAccountPassword String
    Service account password for access OpenLdap service (string)
    startTls Boolean
    testPassword String
    Password for test access to OpenLdap service (string)
    testUsername String
    Username for test access to OpenLdap service (string)
    tls Boolean
    Enable TLS connection (bool)
    type String
    (Computed) The type of the resource (string)
    userDisabledBitMask Number
    User disabled bit mask (int)
    userEnabledAttribute String
    User enable attribute (string)
    userLoginAttribute String
    User login attribute. Default uid (string)
    userMemberAttribute String
    User member attribute. Default memberOf (string)
    userNameAttribute String
    User name attribute. Default givenName (string)
    userObjectClass String
    User object class. Default inetorgperson (string)
    userSearchAttribute String
    User search attribute. Default uid|sn|givenName (string)
    userSearchBase String
    User search base DN (string)
    userSearchFilter String

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi
    pulumi/pulumi-rancher2