Misc Documentation Fixes (#7662)

* Update parameter names to match URL placeholders

* Fix incorrect parameter quoting

Without the separated quoting, the entire `ec2_alias (string: "role_id")` string becomes an anchor link.

* Fix default value for userattr

vault/sdk/helper/ldaputil/config.go shows userattr has a default value of "cn"

* Fix default value for url

Documentation says it's required, but vault/sdk/helper/ldaputil/config.go shows that url has a default value.

* Fix default value for url

Documentation says it's required, but vault/sdk/helper/ldaputil/config.go shows that url has a default value.
This commit is contained in:
Marcus T 2019-11-19 14:17:45 -08:00 committed by Clint
parent 9384d8ba69
commit d61b425aec
4 changed files with 7 additions and 7 deletions

View File

@ -158,7 +158,7 @@ This configures the way that Vault interacts with the
Vault won't be aware and any identity aliases set up for the role name will
still be valid.
- `ec2_alias (string: "role_id")` - Configures how to generate the identity
- `ec2_alias` `(string: "role_id")` - Configures how to generate the identity
alias when using the `ec2` auth method. Valid choices are `role_id`,
`instance_id`, and `image_id`. When `role_id` is selected, the randomly
generated ID of the role is used. When `instance_id` is selected, the

View File

@ -97,7 +97,7 @@ Map a list of policies to a team that exists in the configured GitHub organizati
### Parameters
- `key` `(string)` - GitHub team name in "slugified" format
- `team_name` `(string)` - GitHub team name in "slugified" format
- `value` `(string)` - Comma separated list of policies to assign
### Sample Payload
@ -164,7 +164,7 @@ organization.
### Parameters
- `key` `(string)` - GitHub user name
- `user_name` `(string)` - GitHub user name
- `value` `(string)` - Comma separated list of policies to assign
### Sample Payload

View File

@ -27,7 +27,7 @@ This endpoint configures the LDAP auth method.
### Parameters
- `url` `(string: <required>)` The LDAP server to connect to. Examples:
- `url` `(string: ldap://127.0.0.1)` The LDAP server to connect to. Examples:
`ldap://ldap.myorg.com`, `ldaps://ldap.myorg.com:636`. Multiple URLs can be
specified with commas, e.g. `ldap://ldap.myorg.com,ldap://ldap2.myorg.com`;
these will be tried in-order.
@ -52,7 +52,7 @@ This endpoint configures the LDAP auth method.
user search.
- `userdn` `(string: "")` Base DN under which to perform user search. Example:
`ou=Users,dc=example,dc=com`
- `userattr` `(string: "")` Attribute on user attribute object matching the
- `userattr` `(string: "cn")` Attribute on user attribute object matching the
username passed when authenticating. Examples: `sAMAccountName`, `cn`, `uid`
- `discoverdn` `(bool: false)` Use anonymous bind to discover the bind DN of a
user.

View File

@ -34,7 +34,7 @@ text that fulfills those requirements. `{{PASSWORD}}` must appear exactly once a
### Connection parameters
* `url` (string, required) - The LDAP server to connect to. Examples: `ldaps://ldap.myorg.com`, `ldaps://ldap.myorg.com:636`. This can also be a comma-delineated list of URLs, e.g. `ldaps://ldap.myorg.com,ldaps://ldap.myorg.com:636`, in which case the servers will be tried in-order if there are errors during the connection process.
* `url` (string, optional) - The LDAP server to connect to. Examples: `ldaps://ldap.myorg.com`, `ldaps://ldap.myorg.com:636`. This can also be a comma-delineated list of URLs, e.g. `ldaps://ldap.myorg.com,ldaps://ldap.myorg.com:636`, in which case the servers will be tried in-order if there are errors during the connection process. Default is `ldap://127.0.0.1`.
* `starttls` (bool, optional) - If true, issues a `StartTLS` command after establishing an unencrypted connection.
* `insecure_tls` - (bool, optional) - If true, skips LDAP server SSL certificate verification - insecure, use with caution!
* `certificate` - (string, optional) - CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.
@ -437,4 +437,4 @@ $ curl \
--request GET \
--data @payload.json \
http://127.0.0.1:8200/v1/ad/rotate-root
```
```