mirror of https://github.com/hashicorp/boundary
docs: Add multiple grant scopes commands (#4317)
* docs: Add multiple grant scopes commands * fixes example role ID * removes statements about each scope requiring its own role --------- Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>pull/4342/head
parent
59cae8b7c5
commit
c3e49fa337
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: roles add-grant-scopes - Command
|
||||
description: |-
|
||||
The "roles add-grant-scopes" command lets you add grant scopes to a role.
|
||||
---
|
||||
|
||||
# roles add-grant-scopes
|
||||
|
||||
Command: `roles add-grant-scopes`
|
||||
|
||||
The `roles add-grant-scopes` command lets you add grant scopes to a role.
|
||||
You can specify multiple grant scopes per role.
|
||||
|
||||
## Example
|
||||
|
||||
This example adds a grant to a role with the ID `o_1234567890` in the current scope and any children scopes:
|
||||
|
||||
```shell-session
|
||||
$ boundary roles add-grant-scopes -id r_1234567890 -grant-scope-id "this" -grant-scope-id "children"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
<CodeBlockConfig hideClipboard>
|
||||
|
||||
```shell-session
|
||||
$ boundary roles add-grant-scopes [options] [args]
|
||||
```
|
||||
|
||||
</CodeBlockConfig>
|
||||
|
||||
### Command options
|
||||
|
||||
- `-grant-scope-id=<string>` - The scope IDs that inherit grants set on the role.
|
||||
You can specify the following values:
|
||||
- `this` - Applies to the current scope.
|
||||
- `children` - Applies to all direct children of the scope and can only be used with global and org scopes.
|
||||
- `descendants` - Applies to all descendants of the scope and can only be used with the global scope.
|
||||
- `-id=<string>` - The ID of the role you want to add grant scopes to.
|
||||
- `-version=<int>` The version of the role to add grant scopes to.
|
||||
If you do not specify a version, the command performs a check-and-set automatically.
|
||||
|
||||
@include 'cmd-option-note.mdx'
|
||||
@ -0,0 +1,45 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: roles remove-grant-scopes - Command
|
||||
description: |-
|
||||
The "roles remove-grant-scopes" command lets you remove grant scopes from a role.
|
||||
---
|
||||
|
||||
# roles remove-grant-scopes
|
||||
|
||||
Command: `roles remove-grant-scopes`
|
||||
|
||||
The `roles remove-grant-scopes` command lets you remove grant scopes from a role.
|
||||
You can specify multiple grant scopes per role.
|
||||
|
||||
## Example
|
||||
|
||||
This example removes a grant from a role with the ID `r_1234567890` in the current scope and any children scopes:
|
||||
|
||||
```shell-session
|
||||
$ boundary roles remove-grant-scopes -id r_1234567890 -grant-scope-id "this" -grant-scope-id "children"
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
<CodeBlockConfig hideClipboard>
|
||||
|
||||
```shell-session
|
||||
$ boundary roles remove-grant-scopes [options] [args]
|
||||
```
|
||||
|
||||
</CodeBlockConfig>
|
||||
|
||||
### Command options
|
||||
|
||||
- `-grant-scope-id=<string>` - The scope IDs that inherit grants removed from the role.
|
||||
You can specify the following values:
|
||||
- `this` - Applies to the current scope.
|
||||
- `children` - Applies to all direct children of the scope and can only be used with global and org scopes.
|
||||
- `descendants` - Applies to all descendants of the scope and can only be used with the global scope.
|
||||
- `-id=<string>` - The ID of the role you want to remove grant scopes from.
|
||||
- `-version=<int>` The version of the role to remove grant scopes from.
|
||||
If you do not specify a version, the command performs a check-and-set automatically.
|
||||
|
||||
@include 'cmd-option-note.mdx'
|
||||
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: roles set-grant-scopes - Command
|
||||
description: |-
|
||||
The "roles set-grant-scopes" command lets you set the complete set of grant scopes on a role.
|
||||
---
|
||||
|
||||
# roles set-grant-scopes
|
||||
|
||||
Command: `roles set-grant-scopes`
|
||||
|
||||
The `roles set-grant-scopes` command lets you set the complete set of grant scopes on a role.
|
||||
You can specify multiple grant scopes per role.
|
||||
|
||||
## Example
|
||||
|
||||
This example sets the complete set of grant scopes on a role with the ID `r_1234567890` in the current scope and any children scopes:
|
||||
|
||||
```shell-session
|
||||
$ boundary roles add-grant-scopes -id r_1234567890 -grant-scope-id "this" -grant-scope-id "children"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
<CodeBlockConfig hideClipboard>
|
||||
|
||||
```shell-session
|
||||
$ boundary roles set-grants [options] [args]
|
||||
```
|
||||
|
||||
</CodeBlockConfig>
|
||||
|
||||
### Command options
|
||||
|
||||
- `-grant-scope-id=<string>` - The scope IDs that inherit grants set on the role.
|
||||
You can specify the following values:
|
||||
- `this` - Applies to the current scope.
|
||||
- `children` - Applies to all direct children of the scope and can only be used with global and org scopes.
|
||||
- `descendants` - Applies to all descendants of the scope and can only be used with the global scope.
|
||||
- `-id=<string>` - The ID of the role you want to set grant scopes on.
|
||||
- `-version=<int>` The version of the role to set grant scopes on.
|
||||
If you do not specify a version, the command performs a check-and-set automatically.
|
||||
|
||||
@include 'cmd-option-note.mdx'
|
||||
Loading…
Reference in new issue