From a4d55520854e60270da4ddb8d01340b0407f28db Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Tue, 30 Jan 2024 20:22:42 -0500 Subject: [PATCH] docs: Update `id` field for grants (#4292) * docs: Update `id` field for grants * docs: Fix typos --- website/content/docs/commands/roles/add-grants.mdx | 5 ++++- website/content/docs/commands/roles/remove-grants.mdx | 5 ++++- website/content/docs/commands/roles/set-grants.mdx | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/website/content/docs/commands/roles/add-grants.mdx b/website/content/docs/commands/roles/add-grants.mdx index 2c18ae9080..023fdff64d 100644 --- a/website/content/docs/commands/roles/add-grants.mdx +++ b/website/content/docs/commands/roles/add-grants.mdx @@ -36,7 +36,10 @@ $ boundary roles add-grants [options] [args] You can specify grants in compact string format or JSON. If you use JSON, be sure to escape it properly. You can optionally specify multiple grants. -- `-id=` - The ID of the role you want to add grants to. +- `-ids=` - The IDs of the roles you want to add grants to. +You can specify one or more IDs. +If you specify multiple IDs using text, use commas to separate the IDs. +If you specify multiple IDs using JSON, use an array. - `-version=` The version of the role to add grants to. If you do not specify a version, the command performs a check-and-set automatically. diff --git a/website/content/docs/commands/roles/remove-grants.mdx b/website/content/docs/commands/roles/remove-grants.mdx index 6c362c2711..db31ee3971 100644 --- a/website/content/docs/commands/roles/remove-grants.mdx +++ b/website/content/docs/commands/roles/remove-grants.mdx @@ -36,7 +36,10 @@ $ boundary roles remove-grants [options] [args] You can specify grants in compact string format or JSON. If you use JSON, be sure to escape it properly. You can optionally specify multiple grants. -- `-id=` - The ID of the role you want to remove grants from. +- `-ids=` - The IDs of the roles you want to remove grants from. +You can specify one or more IDs. +If you specify multiple IDs using text, use commas to separate the IDs. +If you specify multiple IDs using JSON, use an array. - `-version=` - The version of the role you want to remove grants from. If you do not specify a version, the command performs a check-and-set automatically. diff --git a/website/content/docs/commands/roles/set-grants.mdx b/website/content/docs/commands/roles/set-grants.mdx index 82de90de80..6aac0212af 100644 --- a/website/content/docs/commands/roles/set-grants.mdx +++ b/website/content/docs/commands/roles/set-grants.mdx @@ -37,7 +37,10 @@ $ boundary roles set-grants [options] [args] You can specify grants in compact string format or JSON. If you use JSON, be sure to escape it properly. You can optionally specify multiple grants. -- `-id=` - The ID of the role you want to set grants on. +- `-ids=` - The IDs of the roles you want to set grants on. +You can specify one or more IDs. +If you specify multiple IDs using text, use commas to separate the IDs. +If you specify multiple IDs using JSON, use an array. - `-version=` The version of the role to set grants on. If you do not specify a version, the command performs a check-and-set automatically.