rancher2.AuthConfigFreeIpa
Explore with Pulumi AI
Provides a Rancher v2 Auth Config FreeIpa resource. This can be used to configure and enable Auth Config FreeIpa 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 AuthConfigFreeIpa Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuthConfigFreeIpa(name: string, args: AuthConfigFreeIpaArgs, opts?: CustomResourceOptions);
@overload
def AuthConfigFreeIpa(resource_name: str,
args: AuthConfigFreeIpaArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AuthConfigFreeIpa(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, str]] = 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, 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_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 NewAuthConfigFreeIpa(ctx *Context, name string, args AuthConfigFreeIpaArgs, opts ...ResourceOption) (*AuthConfigFreeIpa, error)
public AuthConfigFreeIpa(string name, AuthConfigFreeIpaArgs args, CustomResourceOptions? opts = null)
public AuthConfigFreeIpa(String name, AuthConfigFreeIpaArgs args)
public AuthConfigFreeIpa(String name, AuthConfigFreeIpaArgs args, CustomResourceOptions options)
type: rancher2:AuthConfigFreeIpa
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 AuthConfigFreeIpaArgs
- 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 AuthConfigFreeIpaArgs
- 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 AuthConfigFreeIpaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthConfigFreeIpaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthConfigFreeIpaArgs
- 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 authConfigFreeIpaResource = new Rancher2.AuthConfigFreeIpa("authConfigFreeIpaResource", 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", "string" },
},
NestedGroupMembershipEnabled = false,
AccessMode = "string",
GroupDnAttribute = "string",
Enabled = false,
GroupMemberMappingAttribute = "string",
StartTls = false,
Certificate = "string",
Annotations =
{
{ "string", "string" },
},
Tls = false,
UserDisabledBitMask = 0,
UserEnabledAttribute = "string",
UserLoginAttribute = "string",
UserMemberAttribute = "string",
UserNameAttribute = "string",
UserObjectClass = "string",
UserSearchAttribute = "string",
AllowedPrincipalIds = new[]
{
"string",
},
UserSearchFilter = "string",
});
example, err := rancher2.NewAuthConfigFreeIpa(ctx, "authConfigFreeIpaResource", &rancher2.AuthConfigFreeIpaArgs{
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.StringMap{
"string": pulumi.String("string"),
},
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.StringMap{
"string": pulumi.String("string"),
},
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 authConfigFreeIpaResource = new AuthConfigFreeIpa("authConfigFreeIpaResource", AuthConfigFreeIpaArgs.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", "string"))
.nestedGroupMembershipEnabled(false)
.accessMode("string")
.groupDnAttribute("string")
.enabled(false)
.groupMemberMappingAttribute("string")
.startTls(false)
.certificate("string")
.annotations(Map.of("string", "string"))
.tls(false)
.userDisabledBitMask(0)
.userEnabledAttribute("string")
.userLoginAttribute("string")
.userMemberAttribute("string")
.userNameAttribute("string")
.userObjectClass("string")
.userSearchAttribute("string")
.allowedPrincipalIds("string")
.userSearchFilter("string")
.build());
auth_config_free_ipa_resource = rancher2.AuthConfigFreeIpa("authConfigFreeIpaResource",
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": "string",
},
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": "string",
},
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 authConfigFreeIpaResource = new rancher2.AuthConfigFreeIpa("authConfigFreeIpaResource", {
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: "string",
},
nestedGroupMembershipEnabled: false,
accessMode: "string",
groupDnAttribute: "string",
enabled: false,
groupMemberMappingAttribute: "string",
startTls: false,
certificate: "string",
annotations: {
string: "string",
},
tls: false,
userDisabledBitMask: 0,
userEnabledAttribute: "string",
userLoginAttribute: "string",
userMemberAttribute: "string",
userNameAttribute: "string",
userObjectClass: "string",
userSearchAttribute: "string",
allowedPrincipalIds: ["string"],
userSearchFilter: "string",
});
type: rancher2:AuthConfigFreeIpa
properties:
accessMode: string
allowedPrincipalIds:
- string
annotations:
string: string
certificate: string
connectionTimeout: 0
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
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
AuthConfigFreeIpa 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 AuthConfigFreeIpa resource accepts the following input properties:
- Servers List<string>
- FreeIpa servers list (list)
- Service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- Service
Account stringPassword - Service account password for access FreeIpa service (string)
- Test
Password string - Password for test access to FreeIpa service (string)
- Test
Username string - Username for test access to FreeIpa service (string)
- User
Search stringBase - User search base DN (string)
- Access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - Allowed
Principal List<string>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - Annotations Dictionary<string, string>
- Annotations of the resource (map)
- Certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- Connection
Timeout int - FreeIpa connection timeout. Default
5000
(int) - Enabled bool
- Enable auth config provider. Default
true
(bool) - Group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - Group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - Group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - Group
Name stringAttribute - Group name attribute. Default
cn
(string) - Group
Object stringClass - Group object class. Default
groupOfNames
(string) - Group
Search stringAttribute - Group search attribute. Default
cn
(string) - Group
Search stringBase - Group search base (string)
- Group
Search stringFilter - Labels Dictionary<string, string>
- Labels of the resource (map)
- Nested
Group boolMembership Enabled - Nested group membership enable. Default
false
(bool) - Port int
- FreeIpa port. Default
389
(int) - Start
Tls bool - Tls bool
- Enable TLS connection (bool)
- User
Disabled intBit Mask - User disabled bit mask (int)
- User
Enabled stringAttribute - User enable attribute (string)
- User
Login stringAttribute - User login attribute. Default
uid
(string) - User
Member stringAttribute - User member attribute. Default
memberOf
(string) - User
Name stringAttribute - User name attribute. Default
givenName
(string) - User
Object stringClass - User object class. Default
inetorgperson
(string) - User
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - User
Search stringFilter
- Servers []string
- FreeIpa servers list (list)
- Service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- Service
Account stringPassword - Service account password for access FreeIpa service (string)
- Test
Password string - Password for test access to FreeIpa service (string)
- Test
Username string - Username for test access to FreeIpa service (string)
- User
Search stringBase - User search base DN (string)
- Access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - Allowed
Principal []stringIds - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - Annotations map[string]string
- Annotations of the resource (map)
- Certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- Connection
Timeout int - FreeIpa connection timeout. Default
5000
(int) - Enabled bool
- Enable auth config provider. Default
true
(bool) - Group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - Group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - Group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - Group
Name stringAttribute - Group name attribute. Default
cn
(string) - Group
Object stringClass - Group object class. Default
groupOfNames
(string) - Group
Search stringAttribute - Group search attribute. Default
cn
(string) - Group
Search stringBase - Group search base (string)
- Group
Search stringFilter - Labels map[string]string
- Labels of the resource (map)
- Nested
Group boolMembership Enabled - Nested group membership enable. Default
false
(bool) - Port int
- FreeIpa port. Default
389
(int) - Start
Tls bool - Tls bool
- Enable TLS connection (bool)
- User
Disabled intBit Mask - User disabled bit mask (int)
- User
Enabled stringAttribute - User enable attribute (string)
- User
Login stringAttribute - User login attribute. Default
uid
(string) - User
Member stringAttribute - User member attribute. Default
memberOf
(string) - User
Name stringAttribute - User name attribute. Default
givenName
(string) - User
Object stringClass - User object class. Default
inetorgperson
(string) - User
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - User
Search stringFilter
- servers List<String>
- FreeIpa servers list (list)
- service
Account StringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account StringPassword - Service account password for access FreeIpa service (string)
- test
Password String - Password for test access to FreeIpa service (string)
- test
Username String - Username for test access to FreeIpa service (string)
- user
Search StringBase - User search base DN (string)
- access
Mode String - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal List<String>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Map<String,String>
- Annotations of the resource (map)
- certificate String
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout Integer - FreeIpa connection timeout. Default
5000
(int) - enabled Boolean
- Enable auth config provider. Default
true
(bool) - group
Dn StringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member StringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member StringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name StringAttribute - Group name attribute. Default
cn
(string) - group
Object StringClass - Group object class. Default
groupOfNames
(string) - group
Search StringAttribute - Group search attribute. Default
cn
(string) - group
Search StringBase - Group search base (string)
- group
Search StringFilter - labels Map<String,String>
- Labels of the resource (map)
- nested
Group BooleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port Integer
- FreeIpa port. Default
389
(int) - start
Tls Boolean - tls Boolean
- Enable TLS connection (bool)
- user
Disabled IntegerBit Mask - User disabled bit mask (int)
- user
Enabled StringAttribute - User enable attribute (string)
- user
Login StringAttribute - User login attribute. Default
uid
(string) - user
Member StringAttribute - User member attribute. Default
memberOf
(string) - user
Name StringAttribute - User name attribute. Default
givenName
(string) - user
Object StringClass - User object class. Default
inetorgperson
(string) - user
Search StringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search StringFilter
- servers string[]
- FreeIpa servers list (list)
- service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account stringPassword - Service account password for access FreeIpa service (string)
- test
Password string - Password for test access to FreeIpa service (string)
- test
Username string - Username for test access to FreeIpa service (string)
- user
Search stringBase - User search base DN (string)
- access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal string[]Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations {[key: string]: string}
- Annotations of the resource (map)
- certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout number - FreeIpa connection timeout. Default
5000
(int) - enabled boolean
- Enable auth config provider. Default
true
(bool) - group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name stringAttribute - Group name attribute. Default
cn
(string) - group
Object stringClass - Group object class. Default
groupOfNames
(string) - group
Search stringAttribute - Group search attribute. Default
cn
(string) - group
Search stringBase - Group search base (string)
- group
Search stringFilter - labels {[key: string]: string}
- Labels of the resource (map)
- nested
Group booleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port number
- FreeIpa port. Default
389
(int) - start
Tls boolean - tls boolean
- Enable TLS connection (bool)
- user
Disabled numberBit Mask - User disabled bit mask (int)
- user
Enabled stringAttribute - User enable attribute (string)
- user
Login stringAttribute - User login attribute. Default
uid
(string) - user
Member stringAttribute - User member attribute. Default
memberOf
(string) - user
Name stringAttribute - User name attribute. Default
givenName
(string) - user
Object stringClass - User object class. Default
inetorgperson
(string) - user
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search stringFilter
- servers Sequence[str]
- FreeIpa servers list (list)
- service_
account_ strdistinguished_ name - Service account DN for access FreeIpa service (string)
- service_
account_ strpassword - Service account password for access FreeIpa service (string)
- test_
password str - Password for test access to FreeIpa service (string)
- test_
username str - Username for test access to FreeIpa service (string)
- user_
search_ strbase - User search base DN (string)
- access_
mode str - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed_
principal_ Sequence[str]ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Mapping[str, str]
- 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 - FreeIpa connection timeout. Default
5000
(int) - enabled bool
- Enable auth config provider. Default
true
(bool) - group_
dn_ strattribute - Group DN attribute. Default
entryDN
(string) - group_
member_ strmapping_ attribute - Group member mapping attribute. Default
member
(string) - group_
member_ struser_ attribute - Group member user attribute. Default
entryDN
(string) - group_
name_ strattribute - Group name attribute. Default
cn
(string) - group_
object_ strclass - Group object class. Default
groupOfNames
(string) - group_
search_ strattribute - Group search attribute. Default
cn
(string) - group_
search_ strbase - Group search base (string)
- group_
search_ strfilter - labels Mapping[str, str]
- Labels of the resource (map)
- nested_
group_ boolmembership_ enabled - Nested group membership enable. Default
false
(bool) - port int
- FreeIpa port. Default
389
(int) - start_
tls bool - tls bool
- Enable TLS connection (bool)
- user_
disabled_ intbit_ mask - User disabled bit mask (int)
- user_
enabled_ strattribute - User enable attribute (string)
- user_
login_ strattribute - User login attribute. Default
uid
(string) - user_
member_ strattribute - User member attribute. Default
memberOf
(string) - user_
name_ strattribute - User name attribute. Default
givenName
(string) - user_
object_ strclass - User object class. Default
inetorgperson
(string) - user_
search_ strattribute - User search attribute. Default
uid|sn|givenName
(string) - user_
search_ strfilter
- servers List<String>
- FreeIpa servers list (list)
- service
Account StringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account StringPassword - Service account password for access FreeIpa service (string)
- test
Password String - Password for test access to FreeIpa service (string)
- test
Username String - Username for test access to FreeIpa service (string)
- user
Search StringBase - User search base DN (string)
- access
Mode String - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal List<String>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Map<String>
- Annotations of the resource (map)
- certificate String
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout Number - FreeIpa connection timeout. Default
5000
(int) - enabled Boolean
- Enable auth config provider. Default
true
(bool) - group
Dn StringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member StringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member StringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name StringAttribute - Group name attribute. Default
cn
(string) - group
Object StringClass - Group object class. Default
groupOfNames
(string) - group
Search StringAttribute - Group search attribute. Default
cn
(string) - group
Search StringBase - Group search base (string)
- group
Search StringFilter - labels Map<String>
- Labels of the resource (map)
- nested
Group BooleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port Number
- FreeIpa port. Default
389
(int) - start
Tls Boolean - tls Boolean
- Enable TLS connection (bool)
- user
Disabled NumberBit Mask - User disabled bit mask (int)
- user
Enabled StringAttribute - User enable attribute (string)
- user
Login StringAttribute - User login attribute. Default
uid
(string) - user
Member StringAttribute - User member attribute. Default
memberOf
(string) - user
Name StringAttribute - User name attribute. Default
givenName
(string) - user
Object StringClass - User object class. Default
inetorgperson
(string) - user
Search StringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search StringFilter
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthConfigFreeIpa resource produces the following output properties:
Look up Existing AuthConfigFreeIpa Resource
Get an existing AuthConfigFreeIpa 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?: AuthConfigFreeIpaState, opts?: CustomResourceOptions): AuthConfigFreeIpa
@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,
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_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) -> AuthConfigFreeIpa
func GetAuthConfigFreeIpa(ctx *Context, name string, id IDInput, state *AuthConfigFreeIpaState, opts ...ResourceOption) (*AuthConfigFreeIpa, error)
public static AuthConfigFreeIpa Get(string name, Input<string> id, AuthConfigFreeIpaState? state, CustomResourceOptions? opts = null)
public static AuthConfigFreeIpa get(String name, Output<String> id, AuthConfigFreeIpaState 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.
- Access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - Allowed
Principal List<string>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - Annotations Dictionary<string, string>
- Annotations of the resource (map)
- Certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- Connection
Timeout int - FreeIpa connection timeout. Default
5000
(int) - Enabled bool
- Enable auth config provider. Default
true
(bool) - Group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - Group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - Group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - Group
Name stringAttribute - Group name attribute. Default
cn
(string) - Group
Object stringClass - Group object class. Default
groupOfNames
(string) - Group
Search stringAttribute - Group search attribute. Default
cn
(string) - Group
Search stringBase - Group search base (string)
- Group
Search stringFilter - Labels Dictionary<string, string>
- Labels of the resource (map)
- Name string
- (Computed) The name of the resource (string)
- Nested
Group boolMembership Enabled - Nested group membership enable. Default
false
(bool) - Port int
- FreeIpa port. Default
389
(int) - Servers List<string>
- FreeIpa servers list (list)
- Service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- Service
Account stringPassword - Service account password for access FreeIpa service (string)
- Start
Tls bool - Test
Password string - Password for test access to FreeIpa service (string)
- Test
Username string - Username for test access to FreeIpa service (string)
- Tls bool
- Enable TLS connection (bool)
- Type string
- (Computed) The type of the resource (string)
- User
Disabled intBit Mask - User disabled bit mask (int)
- User
Enabled stringAttribute - User enable attribute (string)
- User
Login stringAttribute - User login attribute. Default
uid
(string) - User
Member stringAttribute - User member attribute. Default
memberOf
(string) - User
Name stringAttribute - User name attribute. Default
givenName
(string) - User
Object stringClass - User object class. Default
inetorgperson
(string) - User
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - User
Search stringBase - User search base DN (string)
- User
Search stringFilter
- Access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - Allowed
Principal []stringIds - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - Annotations map[string]string
- Annotations of the resource (map)
- Certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- Connection
Timeout int - FreeIpa connection timeout. Default
5000
(int) - Enabled bool
- Enable auth config provider. Default
true
(bool) - Group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - Group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - Group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - Group
Name stringAttribute - Group name attribute. Default
cn
(string) - Group
Object stringClass - Group object class. Default
groupOfNames
(string) - Group
Search stringAttribute - Group search attribute. Default
cn
(string) - Group
Search stringBase - Group search base (string)
- Group
Search stringFilter - Labels map[string]string
- Labels of the resource (map)
- Name string
- (Computed) The name of the resource (string)
- Nested
Group boolMembership Enabled - Nested group membership enable. Default
false
(bool) - Port int
- FreeIpa port. Default
389
(int) - Servers []string
- FreeIpa servers list (list)
- Service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- Service
Account stringPassword - Service account password for access FreeIpa service (string)
- Start
Tls bool - Test
Password string - Password for test access to FreeIpa service (string)
- Test
Username string - Username for test access to FreeIpa service (string)
- Tls bool
- Enable TLS connection (bool)
- Type string
- (Computed) The type of the resource (string)
- User
Disabled intBit Mask - User disabled bit mask (int)
- User
Enabled stringAttribute - User enable attribute (string)
- User
Login stringAttribute - User login attribute. Default
uid
(string) - User
Member stringAttribute - User member attribute. Default
memberOf
(string) - User
Name stringAttribute - User name attribute. Default
givenName
(string) - User
Object stringClass - User object class. Default
inetorgperson
(string) - User
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - User
Search stringBase - User search base DN (string)
- User
Search stringFilter
- access
Mode String - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal List<String>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Map<String,String>
- Annotations of the resource (map)
- certificate String
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout Integer - FreeIpa connection timeout. Default
5000
(int) - enabled Boolean
- Enable auth config provider. Default
true
(bool) - group
Dn StringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member StringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member StringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name StringAttribute - Group name attribute. Default
cn
(string) - group
Object StringClass - Group object class. Default
groupOfNames
(string) - group
Search StringAttribute - Group search attribute. Default
cn
(string) - group
Search StringBase - Group search base (string)
- group
Search StringFilter - labels Map<String,String>
- Labels of the resource (map)
- name String
- (Computed) The name of the resource (string)
- nested
Group BooleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port Integer
- FreeIpa port. Default
389
(int) - servers List<String>
- FreeIpa servers list (list)
- service
Account StringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account StringPassword - Service account password for access FreeIpa service (string)
- start
Tls Boolean - test
Password String - Password for test access to FreeIpa service (string)
- test
Username String - Username for test access to FreeIpa service (string)
- tls Boolean
- Enable TLS connection (bool)
- type String
- (Computed) The type of the resource (string)
- user
Disabled IntegerBit Mask - User disabled bit mask (int)
- user
Enabled StringAttribute - User enable attribute (string)
- user
Login StringAttribute - User login attribute. Default
uid
(string) - user
Member StringAttribute - User member attribute. Default
memberOf
(string) - user
Name StringAttribute - User name attribute. Default
givenName
(string) - user
Object StringClass - User object class. Default
inetorgperson
(string) - user
Search StringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search StringBase - User search base DN (string)
- user
Search StringFilter
- access
Mode string - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal string[]Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations {[key: string]: string}
- Annotations of the resource (map)
- certificate string
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout number - FreeIpa connection timeout. Default
5000
(int) - enabled boolean
- Enable auth config provider. Default
true
(bool) - group
Dn stringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member stringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member stringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name stringAttribute - Group name attribute. Default
cn
(string) - group
Object stringClass - Group object class. Default
groupOfNames
(string) - group
Search stringAttribute - Group search attribute. Default
cn
(string) - group
Search stringBase - Group search base (string)
- group
Search stringFilter - labels {[key: string]: string}
- Labels of the resource (map)
- name string
- (Computed) The name of the resource (string)
- nested
Group booleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port number
- FreeIpa port. Default
389
(int) - servers string[]
- FreeIpa servers list (list)
- service
Account stringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account stringPassword - Service account password for access FreeIpa service (string)
- start
Tls boolean - test
Password string - Password for test access to FreeIpa service (string)
- test
Username string - Username for test access to FreeIpa service (string)
- tls boolean
- Enable TLS connection (bool)
- type string
- (Computed) The type of the resource (string)
- user
Disabled numberBit Mask - User disabled bit mask (int)
- user
Enabled stringAttribute - User enable attribute (string)
- user
Login stringAttribute - User login attribute. Default
uid
(string) - user
Member stringAttribute - User member attribute. Default
memberOf
(string) - user
Name stringAttribute - User name attribute. Default
givenName
(string) - user
Object stringClass - User object class. Default
inetorgperson
(string) - user
Search stringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search stringBase - User search base DN (string)
- user
Search stringFilter
- access_
mode str - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed_
principal_ Sequence[str]ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Mapping[str, str]
- 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 - FreeIpa connection timeout. Default
5000
(int) - enabled bool
- Enable auth config provider. Default
true
(bool) - group_
dn_ strattribute - Group DN attribute. Default
entryDN
(string) - group_
member_ strmapping_ attribute - Group member mapping attribute. Default
member
(string) - group_
member_ struser_ attribute - Group member user attribute. Default
entryDN
(string) - group_
name_ strattribute - Group name attribute. Default
cn
(string) - group_
object_ strclass - Group object class. Default
groupOfNames
(string) - group_
search_ strattribute - Group search attribute. Default
cn
(string) - group_
search_ strbase - Group search base (string)
- group_
search_ strfilter - labels Mapping[str, str]
- Labels of the resource (map)
- name str
- (Computed) The name of the resource (string)
- nested_
group_ boolmembership_ enabled - Nested group membership enable. Default
false
(bool) - port int
- FreeIpa port. Default
389
(int) - servers Sequence[str]
- FreeIpa servers list (list)
- service_
account_ strdistinguished_ name - Service account DN for access FreeIpa service (string)
- service_
account_ strpassword - Service account password for access FreeIpa service (string)
- start_
tls bool - test_
password str - Password for test access to FreeIpa service (string)
- test_
username str - Username for test access to FreeIpa service (string)
- tls bool
- Enable TLS connection (bool)
- type str
- (Computed) The type of the resource (string)
- user_
disabled_ intbit_ mask - User disabled bit mask (int)
- user_
enabled_ strattribute - User enable attribute (string)
- user_
login_ strattribute - User login attribute. Default
uid
(string) - user_
member_ strattribute - User member attribute. Default
memberOf
(string) - user_
name_ strattribute - User name attribute. Default
givenName
(string) - user_
object_ strclass - User object class. Default
inetorgperson
(string) - user_
search_ strattribute - User search attribute. Default
uid|sn|givenName
(string) - user_
search_ strbase - User search base DN (string)
- user_
search_ strfilter
- access
Mode String - Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string) - allowed
Principal List<String>Ids - Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:freeipa_user://<DN>
freeipa_group://<DN>
(list) - annotations Map<String>
- Annotations of the resource (map)
- certificate String
- Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)
- connection
Timeout Number - FreeIpa connection timeout. Default
5000
(int) - enabled Boolean
- Enable auth config provider. Default
true
(bool) - group
Dn StringAttribute - Group DN attribute. Default
entryDN
(string) - group
Member StringMapping Attribute - Group member mapping attribute. Default
member
(string) - group
Member StringUser Attribute - Group member user attribute. Default
entryDN
(string) - group
Name StringAttribute - Group name attribute. Default
cn
(string) - group
Object StringClass - Group object class. Default
groupOfNames
(string) - group
Search StringAttribute - Group search attribute. Default
cn
(string) - group
Search StringBase - Group search base (string)
- group
Search StringFilter - labels Map<String>
- Labels of the resource (map)
- name String
- (Computed) The name of the resource (string)
- nested
Group BooleanMembership Enabled - Nested group membership enable. Default
false
(bool) - port Number
- FreeIpa port. Default
389
(int) - servers List<String>
- FreeIpa servers list (list)
- service
Account StringDistinguished Name - Service account DN for access FreeIpa service (string)
- service
Account StringPassword - Service account password for access FreeIpa service (string)
- start
Tls Boolean - test
Password String - Password for test access to FreeIpa service (string)
- test
Username String - Username for test access to FreeIpa service (string)
- tls Boolean
- Enable TLS connection (bool)
- type String
- (Computed) The type of the resource (string)
- user
Disabled NumberBit Mask - User disabled bit mask (int)
- user
Enabled StringAttribute - User enable attribute (string)
- user
Login StringAttribute - User login attribute. Default
uid
(string) - user
Member StringAttribute - User member attribute. Default
memberOf
(string) - user
Name StringAttribute - User name attribute. Default
givenName
(string) - user
Object StringClass - User object class. Default
inetorgperson
(string) - user
Search StringAttribute - User search attribute. Default
uid|sn|givenName
(string) - user
Search StringBase - User search base DN (string)
- user
Search StringFilter
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rancher2
Terraform Provider.