From 22ecf95449831b141cbe2303bc7044f5250e2e56 Mon Sep 17 00:00:00 2001 From: Hugo Date: Thu, 4 May 2023 16:29:08 +0100 Subject: [PATCH] docs: Explain -format json behaviour on boundary authenticate cmd (#3202) --- website/content/docs/api-clients/cli.mdx | 6 ++++++ website/content/docs/getting-started/deploy-and-login.mdx | 6 ++++++ website/content/docs/oss/installing/run-and-login.mdx | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/website/content/docs/api-clients/cli.mdx b/website/content/docs/api-clients/cli.mdx index f029cae1c5..8043d0c681 100644 --- a/website/content/docs/api-clients/cli.mdx +++ b/website/content/docs/api-clients/cli.mdx @@ -245,3 +245,9 @@ the exact output from the controller. If using the output of the CLI in scripts or as parameters to other tools, _always_ use formatted output. The default text output is meant for human users and the formatting or the information included within that output from the original JSON may change at any time. + +Note that using `-format json` on a `boundary authenticate` command results in +Boundary not saving the token to the system password store. In this case, the +authentication information will only be printed to your terminal in JSON format. +You can use the `BOUNDARY_TOKEN` environment variable or `-token` flag to +provide the token in subsequent commands. diff --git a/website/content/docs/getting-started/deploy-and-login.mdx b/website/content/docs/getting-started/deploy-and-login.mdx index 6a0e1b5d94..1cdebffe96 100644 --- a/website/content/docs/getting-started/deploy-and-login.mdx +++ b/website/content/docs/getting-started/deploy-and-login.mdx @@ -136,6 +136,12 @@ configuration of `pass` or other alternatives is beyond the scope of this article; consult the documentation for `pass` or your specific OS distribution help pages. +Note that if `-format json` is used on this command, Boundary will not save the +token to the system password store. In this case, the authentication information +will only be printed to your terminal in JSON format. You can use the +`BOUNDARY_TOKEN` environment variable or `-token` flag to provide the token in +subsequent commands. + diff --git a/website/content/docs/oss/installing/run-and-login.mdx b/website/content/docs/oss/installing/run-and-login.mdx index 2641744cff..f7b190cb24 100644 --- a/website/content/docs/oss/installing/run-and-login.mdx +++ b/website/content/docs/oss/installing/run-and-login.mdx @@ -43,6 +43,12 @@ configuration of `pass` or other alternatives is beyond the scope of this article; consult the documentation for `pass` or your specific OS distribution help pages. +Note that if `-format json` is used on this command, Boundary will not save the +token to the system password store. In this case, the authentication information +will only be printed to your terminal in JSON format. You can use the +`BOUNDARY_TOKEN` environment variable or `-token` flag to provide the token in +subsequent commands. +