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>
43 lines
1.1 KiB
Plaintext
43 lines
1.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: roles add-principals - Command
|
|
description: >-
|
|
The "roles add-principals" command add principals to an existing role resource. Principals can be users or groups.
|
|
---
|
|
|
|
# roles add-principals
|
|
|
|
Command: `roles add-principals`
|
|
|
|
The `roles add-principals` command lets you add principals to a role.
|
|
Principals can be users or groups.
|
|
You can specify multiple principals per role.
|
|
|
|
## Example
|
|
|
|
This example adds the principals `$GROUP_ID` to a role with the ID `r_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary roles add-principals -id r_1234567890 -principal=$GROUP_ID
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary roles add-principals [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-id=<string>` - The ID of the role you want to add principals to.
|
|
- `-principal=<string>` - The principals you want to add to the role.
|
|
Principals can be users or groups.
|
|
You can optionally specify multiple principals per role.
|
|
- `-version=<int>` The version of the role to add principals to.
|
|
If you do not specify a version, the command performs a check-and-set automatically.
|
|
|
|
@include 'cmd-option-note.mdx' |