1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# OpenbaoClient::LdapConfigureAuthRequest
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **anonymous_group_search** | **Boolean** | Use anonymous binds when performing LDAP group searches (if true the initial credentials will still be used for the initial connection test). | [optional][default to false] |
| **binddn** | **String** | LDAP DN for searching for the user DN (optional) | [optional] |
| **bindpass** | **String** | LDAP password for searching for the user DN (optional) | [optional] |
| **case_sensitive_names** | **Boolean** | If true, case sensitivity will be used when comparing usernames and groups for matching policies. | [optional] |
| **certificate** | **String** | CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded (optional) | [optional] |
| **client_tls_cert** | **String** | Client certificate to provide to the LDAP server, must be x509 PEM encoded (optional) | [optional] |
| **client_tls_key** | **String** | Client certificate key to provide to the LDAP server, must be x509 PEM encoded (optional) | [optional] |
| **connection_timeout** | **Integer** | Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration. | [optional] |
| **deny_null_bind** | **Boolean** | Denies an unauthenticated LDAP bind request if the user's password is empty; defaults to true | [optional][default to true] |
| **dereference_aliases** | **String** | When aliases should be dereferenced on search operations. Accepted values are 'never', 'finding', 'searching', 'always'. Defaults to 'never'. | [optional][default to 'never'] |
| **discoverdn** | **Boolean** | Use anonymous bind to discover the bind DN of a user (optional) | [optional] |
| **groupattr** | **String** | LDAP attribute to follow on objects returned by <groupfilter> in order to enumerate user group membership. Examples: \"cn\" or \"memberOf\", etc. Default: cn | [optional][default to 'cn'] |
| **groupdn** | **String** | LDAP search base to use for group membership search (eg: ou=Groups,dc=example,dc=org) | [optional] |
| **groupfilter** | **String** | Go template for querying group membership of user (optional) The template can access the following context variables: UserDN, Username Example: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}})) Default: (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})) | [optional][default to '(|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}}))'] |
| **insecure_tls** | **Boolean** | Skip LDAP server SSL Certificate verification - VERY insecure (optional) | [optional] |
| **max_page_size** | **Integer** | If set to a value greater than 0, the LDAP backend will use the LDAP server's paged search control to request pages of up to the given size. This can be used to avoid hitting the LDAP server's maximum result size limit. Otherwise, the LDAP backend will not use the paged search control. | [optional][default to 0] |
| **request_timeout** | **Integer** | Timeout, in seconds, for the connection when making requests against the server before returning back an error. | [optional] |
| **starttls** | **Boolean** | Issue a StartTLS command after establishing unencrypted connection (optional) | [optional] |
| **tls_max_version** | **String** | Maximum TLS version to use. Accepted values are 'tls10', 'tls11', 'tls12' or 'tls13'. Defaults to 'tls12' | [optional][default to 'tls12'] |
| **tls_min_version** | **String** | Minimum TLS version to use. Accepted values are 'tls10', 'tls11', 'tls12' or 'tls13'. Defaults to 'tls12' | [optional][default to 'tls12'] |
| **token_bound_cidrs** | **Array<String>** | Comma separated string or JSON list of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token. | [optional] |
| **token_explicit_max_ttl** | **Integer** | If set, tokens created via this role carry an explicit maximum TTL. During renewal, the current maximum TTL values of the role and the mount are not checked for changes, and any updates to these values will have no effect on the token being renewed. | [optional] |
| **token_max_ttl** | **Integer** | The maximum lifetime of the generated token | [optional] |
| **token_no_default_policy** | **Boolean** | If true, the 'default' policy will not automatically be added to generated tokens | [optional] |
| **token_num_uses** | **Integer** | The maximum number of times a token may be used, a value of zero means unlimited | [optional] |
| **token_period** | **Integer** | If set, tokens created via this role will have no max lifetime; instead, their renewal period will be fixed to this value. This takes an integer number of seconds, or a string duration (e.g. \"24h\"). | [optional] |
| **token_policies** | **Array<String>** | Comma-separated list of policies. This will apply to all tokens generated by this auth method, in addition to any configured for specific users/groups. | [optional] |
| **token_strictly_bind_ip** | **Boolean** | If true, CIDRs for the token will be strictly bound to the source IP address of the login request | [optional] |
| **token_ttl** | **Integer** | The initial ttl of the token to generate | [optional] |
| **token_type** | **String** | The type of token to generate, service or batch | [optional][default to 'default-service'] |
| **upndomain** | **String** | Enables userPrincipalDomain login with [username]@UPNDomain (optional) | [optional] |
| **url** | **String** | LDAP URL to connect to (default: ldap://127.0.0.1). Multiple URLs can be specified by concatenating them with commas; they will be tried in-order. | [optional][default to 'ldap://127.0.0.1'] |
| **use_pre111_group_cn_behavior** | **Boolean** | In Vault 1.1.1 (prior to OpenBao's fork), a fix for handling group CN values of different cases unfortunately introduced a regression that could cause previously defined groups to not be found due to a change in the resulting name. If set true, the pre-1.1.1 behavior for matching group CNs will be used. This is only needed in some upgrade scenarios for backwards compatibility. It is enabled by default if the config is upgraded but disabled by default on new configurations. | [optional] |
| **use_token_groups** | **Boolean** | If true, use the Active Directory tokenGroups constructed attribute of the user to find the group memberships. This will find all security groups including nested ones. | [optional][default to false] |
| **userattr** | **String** | Attribute used for users (default: cn) | [optional][default to 'cn'] |
| **userdn** | **String** | LDAP domain to use for users (eg: ou=People,dc=example,dc=org) | [optional] |
| **userfilter** | **String** | Go template for LDAP user search filer (optional) The template can access the following context variables: UserAttr, Username Default: ({{.UserAttr}}={{.Username}}) | [optional][default to '({{.UserAttr}}={{.Username}})'] |
| **username_as_alias** | **Boolean** | If true, sets the alias name to the username | [optional][default to false] |
## Example
```ruby
require 'openbao_client'
instance = OpenbaoClient::LdapConfigureAuthRequest.new(
anonymous_group_search: null,
binddn: null,
bindpass: null,
case_sensitive_names: null,
certificate: null,
client_tls_cert: null,
client_tls_key: null,
connection_timeout: null,
deny_null_bind: null,
dereference_aliases: null,
discoverdn: null,
groupattr: null,
groupdn: null,
groupfilter: null,
insecure_tls: null,
max_page_size: null,
request_timeout: null,
starttls: null,
tls_max_version: null,
tls_min_version: null,
token_bound_cidrs: null,
token_explicit_max_ttl: null,
token_max_ttl: null,
token_no_default_policy: null,
token_num_uses: null,
token_period: null,
token_policies: null,
token_strictly_bind_ip: null,
token_ttl: null,
token_type: null,
upndomain: null,
url: null,
use_pre111_group_cn_behavior: null,
use_token_groups: null,
userattr: null,
userdn: null,
userfilter: null,
username_as_alias: null
)
```
|
