ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
99 lines
2.5 KiB
Plaintext
99 lines
2.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: auth-methods list - Command
|
|
description: |-
|
|
The "auth-methods list" command lets Boundary admin list available auth methods.
|
|
---
|
|
|
|
# auth-methods list
|
|
|
|
Command: `boundary auth-methods list`
|
|
|
|
The `auth-methods list` command lists auth methods within an enclosing scope or
|
|
resource.
|
|
|
|
|
|
## Examples
|
|
|
|
The following example lists auth methods from the default `global` scope recursively from any child scopes, if applicable:
|
|
|
|
```shell-session
|
|
$ boundary auth-methods list -recursive
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Auth Method information:
|
|
ID: amoidc_1234567890
|
|
Scope ID: global
|
|
Version: 1
|
|
Type: oidc
|
|
Name: Generated global scope initial oidc auth method
|
|
Description: Provides initial administrative and unprivileged authentication into Boundary
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
change-state
|
|
authenticate
|
|
|
|
ID: ampw_1234567890
|
|
Scope ID: global
|
|
Version: 1
|
|
Type: password
|
|
Name: Generated global scope initial password auth method
|
|
Description: Provides initial administrative and unprivileged authentication into Boundary
|
|
Is Primary For Scope: true
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
authenticate
|
|
|
|
ID: ampw_ZbB6UXpW3B
|
|
Scope ID: o_u54jrD6ydN
|
|
Version: 1
|
|
Type: password
|
|
Name: org_auth_method
|
|
Description: Org auth method
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
authenticate
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary auth-methods list [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
### Command options
|
|
|
|
- `-filter` `(string: "")` - If set, the list operation is filtered before
|
|
being returned. The filter operates against each item in the list. We recommend using
|
|
single quotes, because filters contain double quotes.
|
|
|
|
- `-recursive` - If set, the list operation is applied
|
|
recursively into child scopes, if supported by the type. The default value is
|
|
`false`.
|
|
|
|
- `-scope-id` `(string: "")` - The scope in which to make the request. The default
|
|
scope is `global`. You can also specify a scope using the **BOUNDARY_SCOPE_ID** environment
|
|
variable.
|
|
|
|
@include 'cmd-option-note.mdx' |