Skip to content

Commit

Permalink
More naming cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
sethvargo committed Oct 24, 2017
1 parent 9bb7ccd commit 50caac0
Show file tree
Hide file tree
Showing 32 changed files with 238 additions and 221 deletions.
2 changes: 1 addition & 1 deletion website/source/api/auth/app-id/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ general information about the usage and operation of the App ID method, please
see the [Vault App ID method documentation](/docs/auth/app-id.html).

This documentation assumes the App ID method is mounted at the `/auth/app-id`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.
2 changes: 1 addition & 1 deletion website/source/api/auth/approle/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ general information about the usage and operation of the AppRole method, please
see the [Vault AppRole method documentation](/docs/auth/approle.html).

This documentation assumes the AppRole method is mounted at the `/auth/approle`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## List Roles
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/aws/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ general information about the usage and operation of the AWS method, please
see the [Vault AWS method documentation](/docs/auth/aws.html).

This documentation assumes the AWS method is mounted at the `/auth/aws`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Configure Client
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/cert/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ method. For general information about the usage and operation of the TLS
Certificate method, please see the [Vault TLS Certificate method documentation](/docs/auth/cert.html).

This documentation assumes the TLS Certificate method is mounted at the
`/auth/cert` path in Vault. Since it is possible to mount auth methods at any
`/auth/cert` path in Vault. Since it is possible to enable auth methods at any
location, please update your API calls accordingly.

## Create CA Certificate Role
Expand Down
27 changes: 15 additions & 12 deletions website/source/api/auth/gcp/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ plugin. To learn more about the usage and operation, see the
[Vault GCP method documentation](/docs/auth/gcp.html).

This documentation assumes the plugin method is mounted at the
`/auth/gcp` path in Vault. Since it is possible to mount auth methods
`/auth/gcp` path in Vault. Since it is possible to enable auth methods
at any location, please update your API calls accordingly.

## Configure
Expand Down Expand Up @@ -42,7 +42,7 @@ to confirm signed JWTs passed in during login.
for that server's machine.

- `google_certs_endpoint` `(string: "")`: The Google OAuth2 endpoint to obtain public certificates for. This is used
primarily for testing and should generally not be set. If not set, will default to the [Google public certs
primarily for testing and should generally not be set. If not set, will default to the [Google public certs
endpoint](https://www.googleapis.com/oauth2/v3/certs)

### Sample Payload
Expand Down Expand Up @@ -145,29 +145,32 @@ entities attempting to login.
A comma-separated list of service account emails or ids.
Defines the service accounts that login is restricted to. If set to `\*`, all
service accounts are allowed (role will still be bound by project). Will be
inferred from service account used to issue metadata token for GCE instances.
inferred from service account used to issue metadata token for GCE instances.

**`iam`-only params**:
- `max_jwt_exp` `(string: "")` - Optional, defaults to 900 (15min).
Number of seconds past the time of authentication that the login param JWT
must expire within. For example, if a user attempts to login with a token
that expires within an hour and this is set to 15 minutes, Vault will return
an error prompting the user to create a new signed JWT with a shorter `exp`.
an error prompting the user to create a new signed JWT with a shorter `exp`.
The GCE metadata tokens currently do not allow the `exp` claim to be customized.

- `allow_gce_inference` `(bool: true)` - A flag to determine if this role should
allow GCE instances to authenticate by inferring service accounts from the
allow GCE instances to authenticate by inferring service accounts from the
GCE identity metadata token.

**`gce`-only params**:
- `bound_zone` `(string: "")`: If set, determines the zone that a GCE instance must belong to.

- `bound_zone` `(string: "")`: If set, determines the zone that a GCE instance must belong to.
If bound_instance_group is provided, it is assumed to be a zonal group and the group must belong to this zone.
- `bound_region` `(string: "")`: If set, determines the region that a GCE instance must belong to.
If bound_instance_group is provided, it is assumed to be a regional group and the group must belong to this region.

- `bound_region` `(string: "")`: If set, determines the region that a GCE instance must belong to.
If bound_instance_group is provided, it is assumed to be a regional group and the group must belong to this region.
**If bound_zone is provided, region will be ignored.**
- `bound_instance_group` `(string: "")`: If set, determines the instance group that an authorized instance must belong to.
bound_zone or bound_region must also be set if bound_instance_group is set.
- `bound_labels` `(array: [])`: A comma-separated list of Google Cloud Platform labels formatted as "$key:$value" strings that
must be set on authorized GCE instances. Because GCP labels are not currently ACL'd, we recommend that this be used in
must be set on authorized GCE instances. Because GCP labels are not currently ACL'd, we recommend that this be used in
conjunction with other restrictions.

### Sample Payload
Expand Down Expand Up @@ -282,7 +285,7 @@ service accounts on the role.
- `name` `(string: <required>)` - Name of an existing `gce` role. Returns error if role is not an `gce` role.
- `add` `(array: [])` - List of `$key:$value` labels to add to the GCE role's bound labels.
- `remove` `(array: [])` - List of label keys to remove from the role's bound labels.

### Sample Payload

```json
Expand Down Expand Up @@ -424,7 +427,7 @@ entity and then authorizes the entity for the given role.
- `jwt` `(string: "")` - Signed [JSON Web Token](https://tools.ietf.org/html/rfc7519) (JWT).
For `iam`, this is a JWT generated using the IAM API method
[signJwt](https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/signJwt)
or a self-signed JWT. For `gce`, this is an [identity metadata token](https://cloud.google.com/compute/docs/instances/verifying-instance-identity#request_signature).
or a self-signed JWT. For `gce`, this is an [identity metadata token](https://cloud.google.com/compute/docs/instances/verifying-instance-identity#request_signature).


### Sample Payload
Expand Down
6 changes: 3 additions & 3 deletions website/source/api/auth/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ description: |-
# Auth Methods

Each auth method publishes its own set of API paths and methods. These endpoints
are documented in this section. Auth methods are mount at a path, but the
documentation will assume the default mount points for simplicity. If you are
mounting at a different path, you should adjust your API calls accordingly.
are documented in this section. Auth methods are enabled at a path, but the
documentation will assume the default paths for simplicity. If you are enabling
at a different path, you should adjust your API calls accordingly.

For the API documentation for a specific auth method, please choose a auth
method from the navigation.
2 changes: 1 addition & 1 deletion website/source/api/auth/kubernetes/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ learn more about the usage and operation, see the
[Vault Kubernetes auth method](/docs/auth/kubernetes.html).

This documentation assumes the Kubernetes method is mounted at the
`/auth/kubernetes` path in Vault. Since it is possible to mount auth methods at
`/auth/kubernetes` path in Vault. Since it is possible to enable auth methods at
any location, please update your API calls accordingly.

## Configure Method
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/ldap/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ general information about the usage and operation of the LDAP method, please
see the [Vault LDAP method documentation](/docs/auth/ldap.html).

This documentation assumes the LDAP method is mounted at the `/auth/ldap`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Configure LDAP
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/okta/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ general information about the usage and operation of the Okta method, please
see the [Vault Okta method documentation](/docs/auth/okta.html).

This documentation assumes the Okta method is mounted at the `/auth/okta`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Create Configuration
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/radius/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ general information about the usage and operation of the RADIUS method, please
see the [Vault RADIUS method documentation](/docs/auth/radius.html).

This documentation assumes the RADIUS method is mounted at the `/auth/radius`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Configure RADIUS
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/auth/userpass/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ general information about the usage and operation of the Username and Password m
see the [Vault Userpass method documentation](/docs/auth/userpass.html).

This documentation assumes the Username & Password method is mounted at the `/auth/userpass`
path in Vault. Since it is possible to mount auth methods at any location,
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Create/Update User
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/secret/cassandra/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ please see the
[Vault Cassandra backend documentation](/docs/secrets/cassandra/index.html).

This documentation assumes the Cassandra backend is mounted at the `/cassandra`
path in Vault. Since it is possible to mount secrets engines at any location,
path in Vault. Since it is possible to enable secrets engines at any location,
please update your API calls accordingly.

## Configure Connection
Expand Down
8 changes: 4 additions & 4 deletions website/source/api/system/audit-hash.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ layout: "api"
page_title: /sys/audit-hash - HTTP API"
sidebar_current: "docs-http-system-audit-hash"
description: |-
The `/sys/audit-hash` endpoint is used to hash data using an audit backend's
The `/sys/audit-hash` endpoint is used to hash data using an audit device's
hash function and salt.
---

# `/sys/audit-hash`

The `/sys/audit-hash` endpoint is used to calculate the hash of the data used by
an audit backend's hash function and salt. This can be used to search audit logs
an audit device's hash function and salt. This can be used to search audit logs
for a hashed value when the original value is known.

## Calculate Hash

This endpoint hashes the given input data with the specified audit backend's
This endpoint hashes the given input data with the specified audit device's
hash function and salt. This endpoint can be used to discover whether a given
plaintext string (the `input` parameter) appears in the audit log in obfuscated
form.
Expand All @@ -31,7 +31,7 @@ should also be base64-encoded to supply into the `input` parameter.

### Parameters

- `path` `(string: <required>)` – Specifies the path of the audit backend to
- `path` `(string: <required>)` – Specifies the path of the audit device to
generate hashes for. This is part of the request URL.

- `input` `(string: <required>)` – Specifies the input string to hash.
Expand Down
37 changes: 18 additions & 19 deletions website/source/api/system/audit.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ layout: "api"
page_title: "/sys/audit - HTTP API"
sidebar_current: "docs-http-system-audit/"
description: |-
The `/sys/audit` endpoint is used to enable and disable audit backends.
The `/sys/audit` endpoint is used to enable and disable audit devices.
---

# `/sys/audit`

The `/sys/audit` endpoint is used to list, mount, and unmount audit backends.
Audit backends must be enabled before use, and more than one backend may be
The `/sys/audit` endpoint is used to list, enable, and disable audit devices.
Audit devices must be enabled before use, and more than one device may be
enabled at a time.

## List Mounted Audit Backends
## List Enabled Audit Devices

This endpoint lists only the mounted audit backends (it does not list all
available audit backends).
This endpoint lists only the enabled audit devices (it does not list all
available audit devices).

- **`sudo` required** – This endpoint requires `sudo` capability in addition to
any path-specific capabilities.
Expand Down Expand Up @@ -46,9 +46,9 @@ $ curl \
}
```

## Mount Audit Backend
## Enable Audit Device

This endpoint mounts a new audit backend at the supplied path. The path can be a
This endpoint enables a new audit device at the supplied path. The path can be a
single word name or a more complex, nested path.

- **`sudo` required** – This endpoint requires `sudo` capability in addition to
Expand All @@ -60,23 +60,22 @@ single word name or a more complex, nested path.

### Parameters

- `path` `(string: <required>)` – Specifies the path in which to mount the audit
backend. This is part of the request URL.
- `path` `(string: <required>)` – Specifies the path in which to enable the audit
device. This is part of the request URL.

- `description` `(string: "")` – Specifies a human-friendly description of the
audit backend.
audit device.

- `options` `(map<string|string>: nil)` – Specifies configuration options to
pass to the audit backend itself. This is dependent on the audit backend type.
pass to the audit device itself. This is dependent on the audit device type.

- `type` `(string: <required>)` – Specifies the type of the audit backend.
- `type` `(string: <required>)` – Specifies the type of the audit device.

Additionally, the following options are allowed in Vault open-source, but
relevant functionality is only supported in Vault Enterprise:

- `local` `(bool: false)` – Specifies if the audit backend is a local mount
only. Local mounts are not replicated nor (if a secondary) removed by
replication.
- `local` `(bool: false)` – Specifies if the audit device is a local only. Local
audit devices are not replicated nor (if a secondary) removed by replication.

### Sample Payload

Expand All @@ -99,9 +98,9 @@ $ curl \
https://vault.rocks/v1/sys/audit/example-audit
```

## Unmount Audit Backend
## Disable Audit Device

This endpoint un-mounts the audit backend at the given path.
This endpoint disables the audit device at the given path.

- **`sudo` required** – This endpoint requires `sudo` capability in addition to
any path-specific capabilities.
Expand All @@ -112,7 +111,7 @@ This endpoint un-mounts the audit backend at the given path.

### Parameters

- `path` `(string: <required>)` – Specifies the path of the audit backend to
- `path` `(string: <required>)` – Specifies the path of the audit device to
delete. This is part of the request URL.

### Sample Request
Expand Down
21 changes: 10 additions & 11 deletions website/source/api/system/auth.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ $ curl \
}
```

## Mount Auth Method
## Enable Auth Method

This endpoint enables a new auth method. After mounting, the auth method can
This endpoint enables a new auth method. After enabling, the auth method can
be accessed and configured via the auth path specified as part of the URL. This
auth path will be nested under the `auth` prefix.

For example, mounting the "foo" auth method will make it accessible at
For example, enable the "foo" auth method will make it accessible at
`/auth/foo`.

- **`sudo` required** – This endpoint requires `sudo` capability in addition to
Expand All @@ -65,7 +65,7 @@ For example, mounting the "foo" auth method will make it accessible at

### Parameters

- `path` `(string: <required>)` – Specifies the path in which to mount the auth
- `path` `(string: <required>)` – Specifies the path in which to enable the auth
method. This is part of the request URL.

- `description` `(string: "")` – Specifies a human-friendly description of the
Expand All @@ -75,7 +75,7 @@ For example, mounting the "foo" auth method will make it accessible at
method type, such as "github" or "token".

- `config` `(map<string|string>: nil)` – Specifies configuration options for
this mount. These are the possible values:
this auth method. These are the possible values:

- `plugin_name`

Expand All @@ -89,9 +89,8 @@ For example, mounting the "foo" auth method will make it accessible at
Additionally, the following options are allowed in Vault open-source, but
relevant functionality is only supported in Vault Enterprise:

- `local` `(bool: false)` – Specifies if the auth method is a local mount
only. Local mounts are not replicated nor (if a secondary) removed by
replication.
- `local` `(bool: false)` – Specifies if the auth method is a local only. Local
auth methods are not replicated nor (if a secondary) removed by replication.

### Sample Payload

Expand All @@ -112,9 +111,9 @@ $ curl \
https://vault.rocks/v1/sys/auth/my-auth
```

## Unmount Auth Method
## Disable Auth Method

This endpoint un-mounts the auth method at the given auth path.
This endpoint disables the auth method at the given auth path.

- **`sudo` required** – This endpoint requires `sudo` capability in addition to
any path-specific capabilities.
Expand All @@ -125,7 +124,7 @@ This endpoint un-mounts the auth method at the given auth path.

### Parameters

- `path` `(string: <required>)` – Specifies the path to unmount. This is part of
- `path` `(string: <required>)` – Specifies the path to disable. This is part of
the request URL.

### Sample Request
Expand Down
4 changes: 2 additions & 2 deletions website/source/api/system/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "System Backend - HTTP API"
sidebar_current: "docs-http-system"
description: |-
The system backend is a default backend in Vault that is mounted at the `/sys`
endpoint. This endpoint cannot be unmounted or moved, and is used to configure
endpoint. This endpoint cannot be disabled or moved, and is used to configure
Vault and interact with many of Vault's internal features.
---

# System Backend

The system backend is a default backend in Vault that is mounted at the `/sys`
endpoint. This endpoint cannot be unmounted or moved, and is used to configure
endpoint. This endpoint cannot be disabled or moved, and is used to configure
Vault and interact with many of Vault's internal features.

For more information about a particular path, please click on it in the sidebar.
Loading

0 comments on commit 50caac0

Please sign in to comment.