open-consul/website/pages/docs/commands/acl/role/delete.mdx

49 lines
992 B
Plaintext
Raw Normal View History

---
2020-04-07 18:55:19 +00:00
layout: docs
page_title: 'Commands: ACL Role Delete'
sidebar_title: delete
---
# Consul ACL Role Delete
Command: `consul acl role delete`
The `acl role delete` command deletes a role. Roles may be deleted by their ID or by name.
## Usage
Usage: `consul acl role delete [options]`
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
2020-04-07 23:56:08 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
#### Command Options
2020-04-07 18:55:19 +00:00
- `-id=<string>` - The ID of the role to delete. It may be specified as a
unique ID prefix but will error if the prefix matches multiple role IDs.
2020-04-07 18:55:19 +00:00
- `-name=<string>` - The Name of the role to delete.
#### Enterprise Options
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
## Examples
Delete a role by prefix:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl role delete -id 57147
Role "57147d87-6bf7-f794-1a6e-7d038c4e4ae9" deleted successfully
```
Delete a role by name:
2020-05-19 18:32:38 +00:00
```shell-session
$ consul acl role delete -name crawler
Role "a365fdc9-ac71-e754-0645-7ab6bd747301" deleted successfully
```