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>
110 lines
3.1 KiB
Plaintext
110 lines
3.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: auth-methods - Command
|
|
description: |-
|
|
The "auth-methods" command lets you create and manage Boundary authentication method configuration.
|
|
---
|
|
|
|
# auth-methods
|
|
|
|
Command: `boundary auth-methods`
|
|
|
|
The `auth-methods` command lets you manage the auth method resource in Boundary. The auth
|
|
method resource provides a mechanism for users to authenticate to
|
|
Boundary. An auth method contains accounts which link an individual user to a
|
|
set of credentials. They also contain managed groups which group accounts that satisfy
|
|
specific criteria, and can be used as principals in roles.
|
|
|
|
## Examples
|
|
|
|
The following example configures an OIDC auth method where the Boundary cluster
|
|
address is stored in the `BOUNDARY_ADDR`, the OIDC provider's client ID is
|
|
stored in the `CLIENT_ID`, and the client secret is stored in the
|
|
`CLIENT_SECRET` environment variables.
|
|
|
|
```shell-session
|
|
$ boundary auth-methods create oidc \
|
|
-issuer "https://dev-1sdl8c0z.us.auth0.com" \
|
|
-client-id "$CLIENT_ID" \
|
|
-client-secret "$CLIENT_SECRET" \
|
|
-signing-algorithm RS256 \
|
|
-api-url-prefix "$BOUNDARY_ADDR" \
|
|
-name "auth0"
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Auth Method information:
|
|
Created Time: Fri, 09 Sep 2022 11:11:55 MDT
|
|
ID: amoidc_40fr5jkLpk
|
|
Name: auth0
|
|
Type: oidc
|
|
Updated Time: Fri, 09 Sep 2022 11:11:55 MDT
|
|
Version: 1
|
|
|
|
Scope:
|
|
ID: global
|
|
Name: global
|
|
Type: global
|
|
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
change-state
|
|
authenticate
|
|
|
|
Authorized Actions on Auth Method's Collections:
|
|
accounts:
|
|
create
|
|
list
|
|
managed-groups:
|
|
create
|
|
list
|
|
|
|
Attributes:
|
|
api_url_prefix: https://e58fe114-7624-431c-994d-b6670e90b03J.boundary.hashicorp.cloud
|
|
callback_url: https://e58fe114-7624-431c-994d-b6670e90b03J.boundary.hashicorp.cloud/v1/auth-methods/oidc:authenticate:callback
|
|
client_id: zaxJLTZh3n14WqSQ7qQ9onuIVRDaZdzz
|
|
client_secret_hmac: Qc3i8NdnTP6rl4JANIg-a2GXgRW5rEKTp2ReIK_BOng
|
|
issuer: https://dev-1sdl8c0z.us.auth0.com
|
|
signing_algorithms: [RS256]
|
|
state: inactive
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
Usage: boundary auth-methods [sub command] [options] [args]
|
|
|
|
# ...
|
|
|
|
Subcommands:
|
|
change-state
|
|
create Create an auth method
|
|
delete Delete an auth method
|
|
list List an auth method
|
|
read Read an auth method
|
|
update Update an auth method
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
For more information, examples, and usage, click on the name
|
|
of the subcommand in the sidebar or one of the links below:
|
|
|
|
- [change-state](/boundary/docs/commands/auth-methods/change-state)
|
|
- [create](/boundary/docs/commands/auth-methods/create)
|
|
- [delete](/boundary/docs/commands/auth-methods/delete)
|
|
- [list](/boundary/docs/commands/auth-methods/list)
|
|
- [read](/boundary/docs/commands/auth-methods/read)
|
|
- [update](/boundary/docs/commands/auth-methods/update)
|