Dan HeathandRobin Beck
b442c1fa60
* docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
45 lines
1.4 KiB
Plaintext
45 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: roles set-grant-scopes - Command
|
|
description: >-
|
|
The "roles set-grant-scopes" command sets the complete set of grant scopes on an existing role resource.
|
|
---
|
|
|
|
# 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 set-grant-scopes -id r_1234567890 -grant-scope-id "this" -grant-scope-id "children"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary roles set-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 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'
|