From aa1764e4706b27acf482d9744fab91b47a5aa1e7 Mon Sep 17 00:00:00 2001 From: Michael Golowka <72365+pcman312@users.noreply.github.com> Date: Tue, 28 Apr 2020 13:55:07 -0600 Subject: [PATCH] GCP Auth docs - Move `iam_alias` and `gce_alias` to config instead of role (#8862) Move `iam_alias` and `gce_alias` to config instead of role --- website/pages/api-docs/auth/gcp/index.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/website/pages/api-docs/auth/gcp/index.mdx b/website/pages/api-docs/auth/gcp/index.mdx index d5b7bd1b93..c03f5b7d4c 100644 --- a/website/pages/api-docs/auth/gcp/index.mdx +++ b/website/pages/api-docs/auth/gcp/index.mdx @@ -44,6 +44,16 @@ to confirm signed JWTs passed in during login. The project must have the `iam.googleapis.com` API [enabled](https://console.cloud.google.com/flows/enableapi?apiid=iam.googleapis.com). +- `iam_alias` `(string: "unique_id")` - Must be either `unique_id` or `role_id`. + If `unique_id` is specified, the service account's unique 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 `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`. + ### Sample Payload ```json @@ -142,11 +152,6 @@ The following parameters are only valid when the role is of type `"iam"`: allow GCE instances to authenticate by inferring service accounts from the GCE identity metadata token. -- `iam_alias` `(string: unique_id)` - Must be either `unique_id` or `role_id`. - If `unique_id` is specified, the service account's unique ID will be used for - alias names. If `role_id` is specified, the ID of the Vault role will be used. - Only used if `type` is `iam`. - #### `gce`-only Parameters The following parameters are only valid when the role is of type `"gce"`: @@ -169,11 +174,6 @@ The following parameters are only valid when the role is of type `"gce"`: GCP labels are not currently ACL'd, we recommend that this be used in conjunction with other restrictions. -- `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. - If `role_id` is specified, the ID of the Vault role will be used. Only used if - `type` is `gce`. - ### Sample Payload Example `iam` role: