Update documentation with new authenticate usage on the CLI (#2865)

* docs: update deploy-and-login getting started guide with new authenticate usage

* docs: update api-clients/cli.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/manage-users-groups.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/workflow-ssh-proxycommand.mdx with new short form usage of authenticate command when using the primary auth method in the global scope

* docs: update oss/installing/no-gen-resources.mdx to remove login-name usage in authenticate command

* docs: update oss/installing/run-and-login.mdx with short form usage of boundary authenticate

* docs: fix tabs

* docs: fix numbering

* Apply batch of suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: fix code blocks

* fixes code blocks

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
This commit is contained in:
authored and GitHub committed 2023-02-07 10:40:31 -05:00
1 parent 1e9057d8a3
commit eea5e80fa2
6 files changed
+31 -30

No files matched your search

@@ -88,15 +88,9 @@ instance, and click **Authenticate**.
instance's Global scope via the web UI. This is the default scope for all new
Boundary clusters.
1. Click **Auth Methods**.
1. Click the **copy icon** for the Password **Auth Method ID**. The ID is needed to
authenticate to HCP Boundary using the CLI.
<Tabs>
<Tab heading="CLI">
1. In the HCP Boundary portal, open the **Boundary Overview** page, and click
the **copy icon** in the **Copy this into Boundary Desktop** section. This
copies your environment’s Boundary **Cluster URL**.
@@ -104,18 +98,26 @@ copies your environment’s Boundary **Cluster URL**.
1. Open a terminal session and set the `BOUNDARY_ADDR` environment variable to
the copied Cluster URL.
```shell-session
$ export BOUNDARY_ADDR=<boundary-cluster-url>
```
```shell-session
$ export BOUNDARY_ADDR=<boundary-cluster-url>
```
1. Log in with the administrator credentials you created when you deployed the
HCP Boundary instance.
```shell-session
$ boundary authenticate password \
-auth-method-id=<boundary-auth-method-id> \
-login-name=<boundary-admin-username>
```
```shell-session
$ boundary authenticate
Please enter the login name (it will be hidden):
Please enter the password (it will be hidden):
Authentication information:
Account ID: acctpw_VOeNSFX8pQ
Auth Method ID: ampw_wxzojlKJLN
Expiration Time: Mon, 13 Feb 2023 12:35:32 MST
User ID: u_1vUkf5fPs9
The token was successfully stored in the chosen keyring and is not displayed here.
```
You are now logged into your HCP Boundary instance's Global scope via the CLI.
This is the default scope for all new Boundary clusters.