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>
63 lines
1.8 KiB
Plaintext
63 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: authenticate oidc - Command
|
|
description: |-
|
|
The "authenticate oidc" command invokes the OIDC auth method to authenticate the Boundary CLI.
|
|
---
|
|
|
|
# authenticate oidc
|
|
|
|
Command: `boundary authenticate oidc`
|
|
|
|
The `authenticate oidc` command lets you invoke the OIDC auth method to authenticate the
|
|
Boundary CLI.
|
|
|
|
The OIDC authentication method lets Boundary users delegate authentication
|
|
to an OIDC provider. OIDC authentication allows Boundary to integrate with widely
|
|
adopted identity providers like Okta, cloud-hosted active directory services
|
|
with an OIDC frontend, and cloud identity management systems such as AWS IAM.
|
|
|
|
## Examples
|
|
|
|
The following command authenticates the Boundary CLI using an OIDC auth method with the ID `amoidc_q7jAdI1QgA`:
|
|
|
|
```shell-session
|
|
$ boundary authenticate oidc -auth-method-id amoidc_q7jAdI1QgA
|
|
Opening returned authentication URL in your browser...
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Authentication information:
|
|
Account ID: acctoidc_f0wWsno9jQ
|
|
Auth Method ID: amoidc_q7jAdI1QgA
|
|
Expiration Time: Wed, 21 Apr 2021 15:02:38 MDT
|
|
User ID: u_zAfnbL9b7y
|
|
|
|
The token was successfully stored in the chosen keyring and is not displayed here.
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary authenticate oidc [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-auth-method-id` `(string: "")` - The auth method resource you want to use for the authentication.
|
|
You can also specify the auth method resource using the **BOUNDARY_AUTH_METHOD_ID** environment variable.
|
|
|
|
- `-scope-id` `(string: "")` - The scope ID to use for the operation.
|
|
You can also specify the scope ID using the **BOUNDARY_SCOPE_ID** environment variable.
|
|
|
|
@include 'cmd-option-note.mdx' |