Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. AuthConfigActiveDirectory
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.AuthConfigActiveDirectory

Explore with Pulumi AI

Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

Provides a Rancher v2 Auth Config ActiveDirectory resource. This can be used to configure and enable Auth Config ActiveDirectory 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 AuthConfigActiveDirectory Resource

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

Constructor syntax

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

@overload
def AuthConfigActiveDirectory(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_username: Optional[str] = None,
                              service_account_password: Optional[str] = None,
                              nested_group_membership_enabled: Optional[bool] = None,
                              default_login_domain: 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, str]] = None,
                              access_mode: Optional[str] = None,
                              port: Optional[int] = None,
                              enabled: Optional[bool] = None,
                              group_dn_attribute: Optional[str] = None,
                              connection_timeout: Optional[int] = None,
                              start_tls: Optional[bool] = None,
                              certificate: Optional[str] = None,
                              annotations: Optional[Mapping[str, str]] = 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_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 NewAuthConfigActiveDirectory(ctx *Context, name string, args AuthConfigActiveDirectoryArgs, opts ...ResourceOption) (*AuthConfigActiveDirectory, error)
public AuthConfigActiveDirectory(string name, AuthConfigActiveDirectoryArgs args, CustomResourceOptions? opts = null)
public AuthConfigActiveDirectory(String name, AuthConfigActiveDirectoryArgs args)
public AuthConfigActiveDirectory(String name, AuthConfigActiveDirectoryArgs args, CustomResourceOptions options)

type: rancher2:AuthConfigActiveDirectory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AuthConfigActiveDirectoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AuthConfigActiveDirectoryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AuthConfigActiveDirectoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AuthConfigActiveDirectoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AuthConfigActiveDirectoryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var authConfigActiveDirectoryResource = new Rancher2.AuthConfigActiveDirectory("authConfigActiveDirectoryResource", new()
{
    Servers = new[]
    {
        "string",
    },
    UserSearchBase = "string",
    TestUsername = "string",
    TestPassword = "string",
    ServiceAccountUsername = "string",
    ServiceAccountPassword = "string",
    NestedGroupMembershipEnabled = false,
    DefaultLoginDomain = "string",
    GroupMemberMappingAttribute = "string",
    GroupMemberUserAttribute = "string",
    GroupNameAttribute = "string",
    GroupObjectClass = "string",
    GroupSearchAttribute = "string",
    GroupSearchBase = "string",
    GroupSearchFilter = "string",
    Labels = 
    {
        { "string", "string" },
    },
    AccessMode = "string",
    Port = 0,
    Enabled = false,
    GroupDnAttribute = "string",
    ConnectionTimeout = 0,
    StartTls = false,
    Certificate = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Tls = false,
    UserDisabledBitMask = 0,
    UserEnabledAttribute = "string",
    UserLoginAttribute = "string",
    UserNameAttribute = "string",
    UserObjectClass = "string",
    UserSearchAttribute = "string",
    AllowedPrincipalIds = new[]
    {
        "string",
    },
    UserSearchFilter = "string",
});
Copy
example, err := rancher2.NewAuthConfigActiveDirectory(ctx, "authConfigActiveDirectoryResource", &rancher2.AuthConfigActiveDirectoryArgs{
	Servers: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserSearchBase:               pulumi.String("string"),
	TestUsername:                 pulumi.String("string"),
	TestPassword:                 pulumi.String("string"),
	ServiceAccountUsername:       pulumi.String("string"),
	ServiceAccountPassword:       pulumi.String("string"),
	NestedGroupMembershipEnabled: pulumi.Bool(false),
	DefaultLoginDomain:           pulumi.String("string"),
	GroupMemberMappingAttribute:  pulumi.String("string"),
	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.StringMap{
		"string": pulumi.String("string"),
	},
	AccessMode:        pulumi.String("string"),
	Port:              pulumi.Int(0),
	Enabled:           pulumi.Bool(false),
	GroupDnAttribute:  pulumi.String("string"),
	ConnectionTimeout: pulumi.Int(0),
	StartTls:          pulumi.Bool(false),
	Certificate:       pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tls:                  pulumi.Bool(false),
	UserDisabledBitMask:  pulumi.Int(0),
	UserEnabledAttribute: pulumi.String("string"),
	UserLoginAttribute:   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"),
})
Copy
var authConfigActiveDirectoryResource = new AuthConfigActiveDirectory("authConfigActiveDirectoryResource", AuthConfigActiveDirectoryArgs.builder()
    .servers("string")
    .userSearchBase("string")
    .testUsername("string")
    .testPassword("string")
    .serviceAccountUsername("string")
    .serviceAccountPassword("string")
    .nestedGroupMembershipEnabled(false)
    .defaultLoginDomain("string")
    .groupMemberMappingAttribute("string")
    .groupMemberUserAttribute("string")
    .groupNameAttribute("string")
    .groupObjectClass("string")
    .groupSearchAttribute("string")
    .groupSearchBase("string")
    .groupSearchFilter("string")
    .labels(Map.of("string", "string"))
    .accessMode("string")
    .port(0)
    .enabled(false)
    .groupDnAttribute("string")
    .connectionTimeout(0)
    .startTls(false)
    .certificate("string")
    .annotations(Map.of("string", "string"))
    .tls(false)
    .userDisabledBitMask(0)
    .userEnabledAttribute("string")
    .userLoginAttribute("string")
    .userNameAttribute("string")
    .userObjectClass("string")
    .userSearchAttribute("string")
    .allowedPrincipalIds("string")
    .userSearchFilter("string")
    .build());
Copy
auth_config_active_directory_resource = rancher2.AuthConfigActiveDirectory("authConfigActiveDirectoryResource",
    servers=["string"],
    user_search_base="string",
    test_username="string",
    test_password="string",
    service_account_username="string",
    service_account_password="string",
    nested_group_membership_enabled=False,
    default_login_domain="string",
    group_member_mapping_attribute="string",
    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": "string",
    },
    access_mode="string",
    port=0,
    enabled=False,
    group_dn_attribute="string",
    connection_timeout=0,
    start_tls=False,
    certificate="string",
    annotations={
        "string": "string",
    },
    tls=False,
    user_disabled_bit_mask=0,
    user_enabled_attribute="string",
    user_login_attribute="string",
    user_name_attribute="string",
    user_object_class="string",
    user_search_attribute="string",
    allowed_principal_ids=["string"],
    user_search_filter="string")
Copy
const authConfigActiveDirectoryResource = new rancher2.AuthConfigActiveDirectory("authConfigActiveDirectoryResource", {
    servers: ["string"],
    userSearchBase: "string",
    testUsername: "string",
    testPassword: "string",
    serviceAccountUsername: "string",
    serviceAccountPassword: "string",
    nestedGroupMembershipEnabled: false,
    defaultLoginDomain: "string",
    groupMemberMappingAttribute: "string",
    groupMemberUserAttribute: "string",
    groupNameAttribute: "string",
    groupObjectClass: "string",
    groupSearchAttribute: "string",
    groupSearchBase: "string",
    groupSearchFilter: "string",
    labels: {
        string: "string",
    },
    accessMode: "string",
    port: 0,
    enabled: false,
    groupDnAttribute: "string",
    connectionTimeout: 0,
    startTls: false,
    certificate: "string",
    annotations: {
        string: "string",
    },
    tls: false,
    userDisabledBitMask: 0,
    userEnabledAttribute: "string",
    userLoginAttribute: "string",
    userNameAttribute: "string",
    userObjectClass: "string",
    userSearchAttribute: "string",
    allowedPrincipalIds: ["string"],
    userSearchFilter: "string",
});
Copy
type: rancher2:AuthConfigActiveDirectory
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: string
    certificate: string
    connectionTimeout: 0
    defaultLoginDomain: string
    enabled: false
    groupDnAttribute: string
    groupMemberMappingAttribute: string
    groupMemberUserAttribute: string
    groupNameAttribute: string
    groupObjectClass: string
    groupSearchAttribute: string
    groupSearchBase: string
    groupSearchFilter: string
    labels:
        string: string
    nestedGroupMembershipEnabled: false
    port: 0
    servers:
        - string
    serviceAccountPassword: string
    serviceAccountUsername: string
    startTls: false
    testPassword: string
    testUsername: string
    tls: false
    userDisabledBitMask: 0
    userEnabledAttribute: string
    userLoginAttribute: string
    userNameAttribute: string
    userObjectClass: string
    userSearchAttribute: string
    userSearchBase: string
    userSearchFilter: string
Copy

AuthConfigActiveDirectory Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AuthConfigActiveDirectory resource accepts the following input properties:

Servers This property is required. List<string>
ActiveDirectory servers list (list)
ServiceAccountPassword This property is required. string
Service account password for access ActiveDirectory service (string)
ServiceAccountUsername This property is required. string
Service account DN for access ActiveDirectory service (string)
TestPassword This property is required. string
Password for test access to ActiveDirectory service (string)
TestUsername This property is required. string
Username for test access to ActiveDirectory service (string)
UserSearchBase This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
Annotations Dictionary<string, string>
Annotations of the resource (map)
Certificate string
CA certificate for TLS if selfsigned (string)
ConnectionTimeout int
ActiveDirectory connection timeout. Default 5000 (int)
DefaultLoginDomain string
ActiveDirectory defult login domain (string)
Enabled bool
Enable auth config provider. Default true (bool)
GroupDnAttribute string
Group DN attribute. Default distinguishedName (string)
GroupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
GroupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
GroupNameAttribute string
Group name attribute. Default name (string)
GroupObjectClass string
Group object class. Default group (string)
GroupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
GroupSearchBase string
Group search base (string)
GroupSearchFilter string
Group search filter (string)
Labels Dictionary<string, string>
Labels of the resource (map)
NestedGroupMembershipEnabled bool
Nested group membership enable. Default false (bool)
Port int
ActiveDirectory port. Default 389 (int)
StartTls bool
Enable start TLS connection (bool)
Tls bool
Enable TLS connection (bool)
UserDisabledBitMask int
User disabled bit mask. Default 2 (int)
UserEnabledAttribute string
User enable attribute (string)
UserLoginAttribute string
User login attribute. Default sAMAccountName (string)
UserNameAttribute string
User name attribute. Default name (string)
UserObjectClass string
User object class. Default person (string)
UserSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
UserSearchFilter string
User search filter (string)
Servers This property is required. []string
ActiveDirectory servers list (list)
ServiceAccountPassword This property is required. string
Service account password for access ActiveDirectory service (string)
ServiceAccountUsername This property is required. string
Service account DN for access ActiveDirectory service (string)
TestPassword This property is required. string
Password for test access to ActiveDirectory service (string)
TestUsername This property is required. string
Username for test access to ActiveDirectory service (string)
UserSearchBase This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
Annotations map[string]string
Annotations of the resource (map)
Certificate string
CA certificate for TLS if selfsigned (string)
ConnectionTimeout int
ActiveDirectory connection timeout. Default 5000 (int)
DefaultLoginDomain string
ActiveDirectory defult login domain (string)
Enabled bool
Enable auth config provider. Default true (bool)
GroupDnAttribute string
Group DN attribute. Default distinguishedName (string)
GroupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
GroupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
GroupNameAttribute string
Group name attribute. Default name (string)
GroupObjectClass string
Group object class. Default group (string)
GroupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
GroupSearchBase string
Group search base (string)
GroupSearchFilter string
Group search filter (string)
Labels map[string]string
Labels of the resource (map)
NestedGroupMembershipEnabled bool
Nested group membership enable. Default false (bool)
Port int
ActiveDirectory port. Default 389 (int)
StartTls bool
Enable start TLS connection (bool)
Tls bool
Enable TLS connection (bool)
UserDisabledBitMask int
User disabled bit mask. Default 2 (int)
UserEnabledAttribute string
User enable attribute (string)
UserLoginAttribute string
User login attribute. Default sAMAccountName (string)
UserNameAttribute string
User name attribute. Default name (string)
UserObjectClass string
User object class. Default person (string)
UserSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
UserSearchFilter string
User search filter (string)
servers This property is required. List<String>
ActiveDirectory servers list (list)
serviceAccountPassword This property is required. String
Service account password for access ActiveDirectory service (string)
serviceAccountUsername This property is required. String
Service account DN for access ActiveDirectory service (string)
testPassword This property is required. String
Password for test access to ActiveDirectory service (string)
testUsername This property is required. String
Username for test access to ActiveDirectory service (string)
userSearchBase This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Map<String,String>
Annotations of the resource (map)
certificate String
CA certificate for TLS if selfsigned (string)
connectionTimeout Integer
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain String
ActiveDirectory defult login domain (string)
enabled Boolean
Enable auth config provider. Default true (bool)
groupDnAttribute String
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute String
Group member mapping attribute. Default member (string)
groupMemberUserAttribute String
Group member user attribute. Default distinguishedName (string)
groupNameAttribute String
Group name attribute. Default name (string)
groupObjectClass String
Group object class. Default group (string)
groupSearchAttribute String
Group search attribute. Default sAMAccountName (string)
groupSearchBase String
Group search base (string)
groupSearchFilter String
Group search filter (string)
labels Map<String,String>
Labels of the resource (map)
nestedGroupMembershipEnabled Boolean
Nested group membership enable. Default false (bool)
port Integer
ActiveDirectory port. Default 389 (int)
startTls Boolean
Enable start TLS connection (bool)
tls Boolean
Enable TLS connection (bool)
userDisabledBitMask Integer
User disabled bit mask. Default 2 (int)
userEnabledAttribute String
User enable attribute (string)
userLoginAttribute String
User login attribute. Default sAMAccountName (string)
userNameAttribute String
User name attribute. Default name (string)
userObjectClass String
User object class. Default person (string)
userSearchAttribute String
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchFilter String
User search filter (string)
servers This property is required. string[]
ActiveDirectory servers list (list)
serviceAccountPassword This property is required. string
Service account password for access ActiveDirectory service (string)
serviceAccountUsername This property is required. string
Service account DN for access ActiveDirectory service (string)
testPassword This property is required. string
Password for test access to ActiveDirectory service (string)
testUsername This property is required. string
Username for test access to ActiveDirectory service (string)
userSearchBase This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations {[key: string]: string}
Annotations of the resource (map)
certificate string
CA certificate for TLS if selfsigned (string)
connectionTimeout number
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain string
ActiveDirectory defult login domain (string)
enabled boolean
Enable auth config provider. Default true (bool)
groupDnAttribute string
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
groupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
groupNameAttribute string
Group name attribute. Default name (string)
groupObjectClass string
Group object class. Default group (string)
groupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
groupSearchBase string
Group search base (string)
groupSearchFilter string
Group search filter (string)
labels {[key: string]: string}
Labels of the resource (map)
nestedGroupMembershipEnabled boolean
Nested group membership enable. Default false (bool)
port number
ActiveDirectory port. Default 389 (int)
startTls boolean
Enable start TLS connection (bool)
tls boolean
Enable TLS connection (bool)
userDisabledBitMask number
User disabled bit mask. Default 2 (int)
userEnabledAttribute string
User enable attribute (string)
userLoginAttribute string
User login attribute. Default sAMAccountName (string)
userNameAttribute string
User name attribute. Default name (string)
userObjectClass string
User object class. Default person (string)
userSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchFilter string
User search filter (string)
servers This property is required. Sequence[str]
ActiveDirectory servers list (list)
service_account_password This property is required. str
Service account password for access ActiveDirectory service (string)
service_account_username This property is required. str
Service account DN for access ActiveDirectory service (string)
test_password This property is required. str
Password for test access to ActiveDirectory service (string)
test_username This property is required. str
Username for test access to ActiveDirectory service (string)
user_search_base This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Mapping[str, str]
Annotations of the resource (map)
certificate str
CA certificate for TLS if selfsigned (string)
connection_timeout int
ActiveDirectory connection timeout. Default 5000 (int)
default_login_domain str
ActiveDirectory defult login domain (string)
enabled bool
Enable auth config provider. Default true (bool)
group_dn_attribute str
Group DN attribute. Default distinguishedName (string)
group_member_mapping_attribute str
Group member mapping attribute. Default member (string)
group_member_user_attribute str
Group member user attribute. Default distinguishedName (string)
group_name_attribute str
Group name attribute. Default name (string)
group_object_class str
Group object class. Default group (string)
group_search_attribute str
Group search attribute. Default sAMAccountName (string)
group_search_base str
Group search base (string)
group_search_filter str
Group search filter (string)
labels Mapping[str, str]
Labels of the resource (map)
nested_group_membership_enabled bool
Nested group membership enable. Default false (bool)
port int
ActiveDirectory port. Default 389 (int)
start_tls bool
Enable start TLS connection (bool)
tls bool
Enable TLS connection (bool)
user_disabled_bit_mask int
User disabled bit mask. Default 2 (int)
user_enabled_attribute str
User enable attribute (string)
user_login_attribute str
User login attribute. Default sAMAccountName (string)
user_name_attribute str
User name attribute. Default name (string)
user_object_class str
User object class. Default person (string)
user_search_attribute str
User search attribute. Default sAMAccountName|sn|givenName (string)
user_search_filter str
User search filter (string)
servers This property is required. List<String>
ActiveDirectory servers list (list)
serviceAccountPassword This property is required. String
Service account password for access ActiveDirectory service (string)
serviceAccountUsername This property is required. String
Service account DN for access ActiveDirectory service (string)
testPassword This property is required. String
Password for test access to ActiveDirectory service (string)
testUsername This property is required. String
Username for test access to ActiveDirectory service (string)
userSearchBase This property is required. 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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Map<String>
Annotations of the resource (map)
certificate String
CA certificate for TLS if selfsigned (string)
connectionTimeout Number
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain String
ActiveDirectory defult login domain (string)
enabled Boolean
Enable auth config provider. Default true (bool)
groupDnAttribute String
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute String
Group member mapping attribute. Default member (string)
groupMemberUserAttribute String
Group member user attribute. Default distinguishedName (string)
groupNameAttribute String
Group name attribute. Default name (string)
groupObjectClass String
Group object class. Default group (string)
groupSearchAttribute String
Group search attribute. Default sAMAccountName (string)
groupSearchBase String
Group search base (string)
groupSearchFilter String
Group search filter (string)
labels Map<String>
Labels of the resource (map)
nestedGroupMembershipEnabled Boolean
Nested group membership enable. Default false (bool)
port Number
ActiveDirectory port. Default 389 (int)
startTls Boolean
Enable start TLS connection (bool)
tls Boolean
Enable TLS connection (bool)
userDisabledBitMask Number
User disabled bit mask. Default 2 (int)
userEnabledAttribute String
User enable attribute (string)
userLoginAttribute String
User login attribute. Default sAMAccountName (string)
userNameAttribute String
User name attribute. Default name (string)
userObjectClass String
User object class. Default person (string)
userSearchAttribute String
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchFilter String
User search filter (string)

Outputs

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

Get an existing AuthConfigActiveDirectory 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?: AuthConfigActiveDirectoryState, opts?: CustomResourceOptions): AuthConfigActiveDirectory
@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, str]] = None,
        certificate: Optional[str] = None,
        connection_timeout: Optional[int] = None,
        default_login_domain: Optional[str] = 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, str]] = None,
        name: Optional[str] = None,
        nested_group_membership_enabled: Optional[bool] = None,
        port: Optional[int] = None,
        servers: Optional[Sequence[str]] = None,
        service_account_password: Optional[str] = None,
        service_account_username: 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_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) -> AuthConfigActiveDirectory
func GetAuthConfigActiveDirectory(ctx *Context, name string, id IDInput, state *AuthConfigActiveDirectoryState, opts ...ResourceOption) (*AuthConfigActiveDirectory, error)
public static AuthConfigActiveDirectory Get(string name, Input<string> id, AuthConfigActiveDirectoryState? state, CustomResourceOptions? opts = null)
public static AuthConfigActiveDirectory get(String name, Output<String> id, AuthConfigActiveDirectoryState state, CustomResourceOptions options)
resources:  _:    type: rancher2:AuthConfigActiveDirectory    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
Annotations Dictionary<string, string>
Annotations of the resource (map)
Certificate string
CA certificate for TLS if selfsigned (string)
ConnectionTimeout int
ActiveDirectory connection timeout. Default 5000 (int)
DefaultLoginDomain string
ActiveDirectory defult login domain (string)
Enabled bool
Enable auth config provider. Default true (bool)
GroupDnAttribute string
Group DN attribute. Default distinguishedName (string)
GroupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
GroupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
GroupNameAttribute string
Group name attribute. Default name (string)
GroupObjectClass string
Group object class. Default group (string)
GroupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
GroupSearchBase string
Group search base (string)
GroupSearchFilter string
Group search filter (string)
Labels Dictionary<string, string>
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
ActiveDirectory port. Default 389 (int)
Servers List<string>
ActiveDirectory servers list (list)
ServiceAccountPassword string
Service account password for access ActiveDirectory service (string)
ServiceAccountUsername string
Service account DN for access ActiveDirectory service (string)
StartTls bool
Enable start TLS connection (bool)
TestPassword string
Password for test access to ActiveDirectory service (string)
TestUsername string
Username for test access to ActiveDirectory service (string)
Tls bool
Enable TLS connection (bool)
Type string
(Computed) The type of the resource (string)
UserDisabledBitMask int
User disabled bit mask. Default 2 (int)
UserEnabledAttribute string
User enable attribute (string)
UserLoginAttribute string
User login attribute. Default sAMAccountName (string)
UserNameAttribute string
User name attribute. Default name (string)
UserObjectClass string
User object class. Default person (string)
UserSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
UserSearchBase string
User search base DN (string)
UserSearchFilter string
User search filter (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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
Annotations map[string]string
Annotations of the resource (map)
Certificate string
CA certificate for TLS if selfsigned (string)
ConnectionTimeout int
ActiveDirectory connection timeout. Default 5000 (int)
DefaultLoginDomain string
ActiveDirectory defult login domain (string)
Enabled bool
Enable auth config provider. Default true (bool)
GroupDnAttribute string
Group DN attribute. Default distinguishedName (string)
GroupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
GroupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
GroupNameAttribute string
Group name attribute. Default name (string)
GroupObjectClass string
Group object class. Default group (string)
GroupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
GroupSearchBase string
Group search base (string)
GroupSearchFilter string
Group search filter (string)
Labels map[string]string
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
ActiveDirectory port. Default 389 (int)
Servers []string
ActiveDirectory servers list (list)
ServiceAccountPassword string
Service account password for access ActiveDirectory service (string)
ServiceAccountUsername string
Service account DN for access ActiveDirectory service (string)
StartTls bool
Enable start TLS connection (bool)
TestPassword string
Password for test access to ActiveDirectory service (string)
TestUsername string
Username for test access to ActiveDirectory service (string)
Tls bool
Enable TLS connection (bool)
Type string
(Computed) The type of the resource (string)
UserDisabledBitMask int
User disabled bit mask. Default 2 (int)
UserEnabledAttribute string
User enable attribute (string)
UserLoginAttribute string
User login attribute. Default sAMAccountName (string)
UserNameAttribute string
User name attribute. Default name (string)
UserObjectClass string
User object class. Default person (string)
UserSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
UserSearchBase string
User search base DN (string)
UserSearchFilter string
User search filter (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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Map<String,String>
Annotations of the resource (map)
certificate String
CA certificate for TLS if selfsigned (string)
connectionTimeout Integer
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain String
ActiveDirectory defult login domain (string)
enabled Boolean
Enable auth config provider. Default true (bool)
groupDnAttribute String
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute String
Group member mapping attribute. Default member (string)
groupMemberUserAttribute String
Group member user attribute. Default distinguishedName (string)
groupNameAttribute String
Group name attribute. Default name (string)
groupObjectClass String
Group object class. Default group (string)
groupSearchAttribute String
Group search attribute. Default sAMAccountName (string)
groupSearchBase String
Group search base (string)
groupSearchFilter String
Group search filter (string)
labels Map<String,String>
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
ActiveDirectory port. Default 389 (int)
servers List<String>
ActiveDirectory servers list (list)
serviceAccountPassword String
Service account password for access ActiveDirectory service (string)
serviceAccountUsername String
Service account DN for access ActiveDirectory service (string)
startTls Boolean
Enable start TLS connection (bool)
testPassword String
Password for test access to ActiveDirectory service (string)
testUsername String
Username for test access to ActiveDirectory service (string)
tls Boolean
Enable TLS connection (bool)
type String
(Computed) The type of the resource (string)
userDisabledBitMask Integer
User disabled bit mask. Default 2 (int)
userEnabledAttribute String
User enable attribute (string)
userLoginAttribute String
User login attribute. Default sAMAccountName (string)
userNameAttribute String
User name attribute. Default name (string)
userObjectClass String
User object class. Default person (string)
userSearchAttribute String
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchBase String
User search base DN (string)
userSearchFilter String
User search filter (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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations {[key: string]: string}
Annotations of the resource (map)
certificate string
CA certificate for TLS if selfsigned (string)
connectionTimeout number
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain string
ActiveDirectory defult login domain (string)
enabled boolean
Enable auth config provider. Default true (bool)
groupDnAttribute string
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute string
Group member mapping attribute. Default member (string)
groupMemberUserAttribute string
Group member user attribute. Default distinguishedName (string)
groupNameAttribute string
Group name attribute. Default name (string)
groupObjectClass string
Group object class. Default group (string)
groupSearchAttribute string
Group search attribute. Default sAMAccountName (string)
groupSearchBase string
Group search base (string)
groupSearchFilter string
Group search filter (string)
labels {[key: string]: string}
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
ActiveDirectory port. Default 389 (int)
servers string[]
ActiveDirectory servers list (list)
serviceAccountPassword string
Service account password for access ActiveDirectory service (string)
serviceAccountUsername string
Service account DN for access ActiveDirectory service (string)
startTls boolean
Enable start TLS connection (bool)
testPassword string
Password for test access to ActiveDirectory service (string)
testUsername string
Username for test access to ActiveDirectory service (string)
tls boolean
Enable TLS connection (bool)
type string
(Computed) The type of the resource (string)
userDisabledBitMask number
User disabled bit mask. Default 2 (int)
userEnabledAttribute string
User enable attribute (string)
userLoginAttribute string
User login attribute. Default sAMAccountName (string)
userNameAttribute string
User name attribute. Default name (string)
userObjectClass string
User object class. Default person (string)
userSearchAttribute string
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchBase string
User search base DN (string)
userSearchFilter string
User search filter (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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Mapping[str, str]
Annotations of the resource (map)
certificate str
CA certificate for TLS if selfsigned (string)
connection_timeout int
ActiveDirectory connection timeout. Default 5000 (int)
default_login_domain str
ActiveDirectory defult login domain (string)
enabled bool
Enable auth config provider. Default true (bool)
group_dn_attribute str
Group DN attribute. Default distinguishedName (string)
group_member_mapping_attribute str
Group member mapping attribute. Default member (string)
group_member_user_attribute str
Group member user attribute. Default distinguishedName (string)
group_name_attribute str
Group name attribute. Default name (string)
group_object_class str
Group object class. Default group (string)
group_search_attribute str
Group search attribute. Default sAMAccountName (string)
group_search_base str
Group search base (string)
group_search_filter str
Group search filter (string)
labels Mapping[str, str]
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
ActiveDirectory port. Default 389 (int)
servers Sequence[str]
ActiveDirectory servers list (list)
service_account_password str
Service account password for access ActiveDirectory service (string)
service_account_username str
Service account DN for access ActiveDirectory service (string)
start_tls bool
Enable start TLS connection (bool)
test_password str
Password for test access to ActiveDirectory service (string)
test_username str
Username for test access to ActiveDirectory 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. Default 2 (int)
user_enabled_attribute str
User enable attribute (string)
user_login_attribute str
User login attribute. Default sAMAccountName (string)
user_name_attribute str
User name attribute. Default name (string)
user_object_class str
User object class. Default person (string)
user_search_attribute str
User search attribute. Default sAMAccountName|sn|givenName (string)
user_search_base str
User search base DN (string)
user_search_filter str
User search filter (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: activedirectory_user://<DN> activedirectory_group://<DN>. The local admin (local://<admin id>) and the test_username must be added too. (list)
annotations Map<String>
Annotations of the resource (map)
certificate String
CA certificate for TLS if selfsigned (string)
connectionTimeout Number
ActiveDirectory connection timeout. Default 5000 (int)
defaultLoginDomain String
ActiveDirectory defult login domain (string)
enabled Boolean
Enable auth config provider. Default true (bool)
groupDnAttribute String
Group DN attribute. Default distinguishedName (string)
groupMemberMappingAttribute String
Group member mapping attribute. Default member (string)
groupMemberUserAttribute String
Group member user attribute. Default distinguishedName (string)
groupNameAttribute String
Group name attribute. Default name (string)
groupObjectClass String
Group object class. Default group (string)
groupSearchAttribute String
Group search attribute. Default sAMAccountName (string)
groupSearchBase String
Group search base (string)
groupSearchFilter String
Group search filter (string)
labels Map<String>
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
ActiveDirectory port. Default 389 (int)
servers List<String>
ActiveDirectory servers list (list)
serviceAccountPassword String
Service account password for access ActiveDirectory service (string)
serviceAccountUsername String
Service account DN for access ActiveDirectory service (string)
startTls Boolean
Enable start TLS connection (bool)
testPassword String
Password for test access to ActiveDirectory service (string)
testUsername String
Username for test access to ActiveDirectory service (string)
tls Boolean
Enable TLS connection (bool)
type String
(Computed) The type of the resource (string)
userDisabledBitMask Number
User disabled bit mask. Default 2 (int)
userEnabledAttribute String
User enable attribute (string)
userLoginAttribute String
User login attribute. Default sAMAccountName (string)
userNameAttribute String
User name attribute. Default name (string)
userObjectClass String
User object class. Default person (string)
userSearchAttribute String
User search attribute. Default sAMAccountName|sn|givenName (string)
userSearchBase String
User search base DN (string)
userSearchFilter String
User search filter (string)

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2