From c93edfb612db4106b91ee540d46422cf42f49513 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Fri, 27 Oct 2023 13:32:41 -0400 Subject: [PATCH] docs: Document additional valid principals (#3914) --- .../content/docs/commands/credential-libraries/create.mdx | 5 +++++ .../content/docs/commands/credential-libraries/update.mdx | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/website/content/docs/commands/credential-libraries/create.mdx b/website/content/docs/commands/credential-libraries/create.mdx index e4917c6a31..154f80835d 100644 --- a/website/content/docs/commands/credential-libraries/create.mdx +++ b/website/content/docs/commands/credential-libraries/create.mdx @@ -154,6 +154,11 @@ $ boundary credential-libraries create vault-ssh-certificate [options] [args] The following are options are specific to the Vault SSH certificate credential library, in addition to the command options: +- `-additional-valid-principal` - Any additional users or groups that you want to configure as valid principals. +By default, Boundary only passes the username to Vault to sign as a valid principal. +Use this option when you want to configure additional users or groups as valid principals that the certificate should be signed for in Vault. + + For more information, refer to OpenSSH's definition of [valid principals](https://github.com/openssh/openssh-portable/blob/5f93c4836527d9fda05de8944a1c7b4a205080c7/PROTOCOL.certkeys#L176-L181) and Vault's [SSH secrets engine](https://developer.hashicorp.com/vault/api-docs/secret/ssh#valid_principals) documentation. - `-critical-option` - A key=value pair to add to the request's critical-options map. It can also be a key value only which sets a JSON null as the value. diff --git a/website/content/docs/commands/credential-libraries/update.mdx b/website/content/docs/commands/credential-libraries/update.mdx index 220e63055f..6cc8ed6bfc 100644 --- a/website/content/docs/commands/credential-libraries/update.mdx +++ b/website/content/docs/commands/credential-libraries/update.mdx @@ -151,6 +151,11 @@ $ boundary credential-libraries update vault-ssh-certificate [options] [args] The following are options specific to the Vault SSH certificate credential library, in addition to the command options: +- `-additional-valid-principal` - Any additional users or groups that you want to configure as valid principals. +By default, Boundary only passes the username to Vault as a valid principal. +Use this option when you want to configure additional users or groups as valid principals that the certificate should be signed for in Vault. + + For more information, refer to OpenSSH's definition of [valid principals](https://github.com/openssh/openssh-portable/blob/5f93c4836527d9fda05de8944a1c7b4a205080c7/PROTOCOL.certkeys#L176-L181) and Vault's [SSH secrets engine](https://developer.hashicorp.com/vault/api-docs/secret/ssh#valid_principals) documentation. - `-critical-option` - A key=value pair to add to the request's critical-options map. It can also be a key value only which sets a JSON null as the value.