github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website/content/commands/acl/role/list.mdx

90 lines
2.4 KiB
Plaintext
Raw Normal View History

docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
---
docs: update structure (#8506) - moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
2020-09-01 15:14:13 +00:00
layout: commands
intro and api navigation converted
2020-04-07 18:55:19 +00:00
page_title: 'Commands: ACL Role List'
docs: CLI page descriptions for automated checker (#16056) * ACL * ACL * Catalog * consul config * consul connect * top-level updates * consul intention * consul kv * consul namespace * consul peering * consul peering delete * consul services * consul snapshot * consul tls * consul acl auth-method * acl binding-rule * acl policy * acl role * acl token * fix * standardization * Update website/content/commands/snapshot/save.mdx Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> * consul debug consul keyring Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2023-01-26 18:42:13 +00:00
description: |
The `consul acl role list` command outputs details for all ACL roles, including the policy IDs attached to each role.
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
---
# Consul ACL Role List
Command: `consul acl role list`
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/roles](/consul/api-docs/acl/roles#list-roles)
Added Corresponding HTTP API Endpoints for every CLI command
2022-01-10 17:40:11 +00:00
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
The `acl role list` command lists all roles. By default it will not show metadata.
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
Added ACL requirements for CLI commands
2022-01-10 21:44:56 +00:00
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ------------ |
| `acl:read` |
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
## Usage
Usage: `consul acl role list`
#### Command Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
- `-meta` - Indicates that role metadata such as the content hash and
Raft indices should be shown for each entry.
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
Add acl commands -format option to doc.
2020-03-26 16:03:22 +00:00
Add Namespace support to the API module and the CLI commands (#6874) Also update the Docs and fixup the HTTP API to return proper errors when someone attempts to use Namespaces with an OSS agent. Add Namespace HTTP API docs Make all API endpoints disallow unknown fields
2019-12-06 16:14:56 +00:00
#### Enterprise Options
DOCS: CE-556 Add partition parameter to API endpoint docs (#21374) * CD-556 rename partition partial that's only used in CLI Update CLI pages for partial rename API: Add partial for partition as body option API: Add partial for partition as query parameter Update API peering and members pages * acl/auth-methods.mdx Update partition partials to be generic * binding-rules.mdx, policies.mdx * roles.mdx, templated-policies.mdx * tokens.mdx, catalog.mdx, config.mdx, intentions.mdx * service.mdx, exported-services.mdx, kv.mdx, namespaces.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add partial to acl/auth-methods.mdx Fix headings indent in a few files. * Update website/content/api-docs/acl/auth-methods.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2024-07-18 17:02:45 +00:00
@include 'cli-http-api-partition-options.mdx'
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
Add Namespace support to the API module and the CLI commands (#6874) Also update the Docs and fixup the HTTP API to return proper errors when someone attempts to use Namespaces with an OSS agent. Add Namespace HTTP API docs Make all API endpoints disallow unknown fields
2019-12-06 16:14:56 +00:00
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
#### API Options
@include 'http_api_options_client.mdx'
@include 'http_api_options_server.mdx'
Website fixups for admin partitions (#11842) * Website fixups for admin partitions Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2021-12-15 01:55:21 +00:00
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
## Examples
Default listing.
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
$ consul acl role list
web-crawler:
ID: 57147d87-6bf7-f794-1a6e-7d038c4e4ae9
Description: web crawler updated role
Policies:
2f8f99c7-edd9-2f09-7e4b-a1f519eb4fc2 - crawler-kv
Service Identities:
crawler (Datacenters: all)
archiver:
ID: a365fdc9-ac71-e754-0645-7ab6bd747301
Description: archiver role
Service Identities:
archiver (Datacenters: dc2)
```
Show Metadata.
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
docs: add documentation for all secure acl introduction work (#5640)
2019-05-01 21:11:23 +00:00
$ consul acl role list -meta
web-crawler:
ID: 57147d87-6bf7-f794-1a6e-7d038c4e4ae9
Description: web crawler updated role
Hash: 3bd7c15a77c8d1d45c515378f1176df2e6f76d9c96d541f96de8272ff4dba7b5
Create Index: 18
Modify Index: 39
Policies:
2f8f99c7-edd9-2f09-7e4b-a1f519eb4fc2 - crawler-kv
Service Identities:
crawler (Datacenters: all)
archiver:
ID: a365fdc9-ac71-e754-0645-7ab6bd747301
Description: archiver role
Hash: 9af397ea92ee901366d6333c658195be16f4aee8aa64d2b529b921c879b70a58
Create Index: 22
Modify Index: 22
Service Identities:
archiver (Datacenters: dc2)
```