Skip to content

Commit

Permalink
document new gcp auth metadata fields (#8879)
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrannosaurus-becks committed Apr 29, 2020
1 parent 1a8e61f commit 640c121
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions website/pages/api-docs/auth/gcp/index.mdx
Expand Up @@ -49,11 +49,32 @@ to confirm signed JWTs passed in during login.
alias names during login. If `role_id` is specified, the ID of the Vault role
will be used. Only used if role `type` is `iam`.

- `iam_metadata` `(string: "default")` - The metadata to include on the token
returned by the `login` endpoint. This metadata will be added to both audit logs,
and on the `iam_alias`. By default, it includes `project_id`, `role`,
`service_account_id`, and `service_account_email`. To include no metadata,
set to `""` via the CLI or `[]` via the API. To use only particular fields, select
the explicit fields. To restore to defaults, send only a field of `default`.
**Only select fields that will have a low rate of change** for your `iam_alias` because
each change triggers a storage write and can have a performance impact at scale.
Only used if role `type` is `iam`.

- `gce_alias` `(string: "instance_id")` - Must be either `instance_id` or `role_id`.
If `instance_id` is specified, the GCE instance ID will be used for alias names
during login. If `role_id` is specified, the ID of the Vault role will be used.
Only used if role `type` is `gce`.

- `gce_metadata` `(string: "default")` - The metadata to include on the token
returned by the `login` endpoint. This metadata will be added to both audit logs,
and on the `gce_alias`. By default, it includes `instance_creation_timestamp`,
`instance_id`, `instance_name`, `project_id`, `project_number`, `role`,
`service_account_id`, `service_account_email`, and `zone`. To include no metadata,
set to `""` via the CLI or `[]` via the API. To use only particular fields, select
the explicit fields. To restore to defaults, send only a field of `default`.
**Only select fields that will have a low rate of change** for your `gce_alias` because
each change triggers a storage write and can have a performance impact at scale.
Only used if role `type` is `gce`.

### Sample Payload

```json
Expand Down

0 comments on commit 640c121

Please sign in to comment.