2019-05-01 16:11:23 -05:00
|
|
|
---
|
2020-09-01 10:14:13 -05:00
|
|
|
layout: commands
|
2020-04-07 14:55:19 -04:00
|
|
|
page_title: 'Commands: ACL Auth Method List'
|
2023-01-26 12:42:13 -06:00
|
|
|
description: |
|
|
|
|
The `consul acl auth-method list` command outputs a list of active auth methods.
|
2019-05-01 16:11:23 -05:00
|
|
|
---
|
|
|
|
|
|
|
|
# Consul ACL Auth Method List
|
|
|
|
|
|
|
|
Command: `consul acl auth-method list`
|
|
|
|
|
2023-01-25 10:52:43 -06:00
|
|
|
Corresponding HTTP API Endpoint: [\[GET\] /v1/acl/auth-methods](/consul/api-docs/acl/auth-methods#list-auth-methods)
|
2022-01-10 12:40:11 -05:00
|
|
|
|
|
|
|
The `acl auth-method list` command lists all auth methods. By default it will not show metadata.
|
2019-05-01 16:11:23 -05:00
|
|
|
|
2023-01-25 10:52:43 -06: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)
|
2022-01-10 16:44:56 -05:00
|
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
|
|
|
|
| ACL Required |
|
|
|
|
| ------------ |
|
|
|
|
| `acl:read` |
|
|
|
|
|
2019-05-01 16:11:23 -05:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
Usage: `consul acl auth-method list`
|
|
|
|
|
|
|
|
#### Command Options
|
|
|
|
|
2020-04-07 14:55:19 -04:00
|
|
|
- `-meta` - Indicates that auth method metadata such as the raft indices should
|
2019-05-01 16:11:23 -05:00
|
|
|
be shown for each entry.
|
2020-03-26 19:03:22 +03:00
|
|
|
|
2020-04-07 14:55:19 -04:00
|
|
|
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
|
|
|
|
2019-12-06 11:14:56 -05:00
|
|
|
#### Enterprise Options
|
|
|
|
|
2022-07-26 23:17:11 -07:00
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
|
2020-04-07 14:55:19 -04:00
|
|
|
@include 'http_api_namespace_options.mdx'
|
2019-05-01 16:11:23 -05:00
|
|
|
|
2022-07-26 23:17:11 -07:00
|
|
|
#### API Options
|
|
|
|
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
|
|
|
|
@include 'http_api_options_server.mdx'
|
2021-12-14 17:55:21 -08:00
|
|
|
|
2019-05-01 16:11:23 -05:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
Default listing.
|
|
|
|
|
2020-05-19 14:32:38 -04:00
|
|
|
```shell-session
|
2019-05-01 16:11:23 -05:00
|
|
|
$ consul acl auth-method list
|
|
|
|
minikube:
|
|
|
|
Type: kubernetes
|
|
|
|
Description: minikube auth method
|
|
|
|
minikube-two:
|
|
|
|
Type: kubernetes
|
|
|
|
Description: dev cluster
|
|
|
|
```
|
|
|
|
|
|
|
|
Show Metadata.
|
|
|
|
|
2020-05-19 14:32:38 -04:00
|
|
|
```shell-session
|
2019-05-01 16:11:23 -05:00
|
|
|
$ consul acl auth-method list -meta
|
|
|
|
minikube:
|
|
|
|
Type: kubernetes
|
|
|
|
Description: minikube auth method
|
|
|
|
Create Index: 443
|
|
|
|
Modify Index: 443
|
|
|
|
minikube-two:
|
|
|
|
Type: kubernetes
|
|
|
|
Description: dev cluster
|
|
|
|
Create Index: 445
|
|
|
|
Modify Index: 445
|
|
|
|
```
|