docs: Explain -format json behaviour on boundary authenticate cmd (#3202)

2023-05-04 16:29:08 +01:00
1 parent 7f7a5ac9c3
commit 22ecf95449
@@ -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.
@@ -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.
+
 </Tab>
 <Tab heading="Desktop Client">

@@ -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.
+
 </Tab>
 <Tab heading="Admin Console">