From c1e17f7278b393b2d48f542c4f065ca12459361d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 1 Aug 2024 11:57:52 +0000 Subject: [PATCH] chore: update CLI usage text (#2115) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- README.md | 14 ++++++++++++++ packages/cli-repl/README.md | 14 ++++++++++++++ packages/mongosh/README.md | 14 ++++++++++++++ 3 files changed, 42 insertions(+) diff --git a/README.md b/README.md index 036739f50..80b81b10f 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,20 @@ variable. For detailed instructions for each of our supported platforms, please --keyVaultNamespace [arg] database.collection to store encrypted FLE parameters --kmsURL [arg] Test parameter to override the URL of the KMS endpoint + oidcFlows?: string; + oidcRedirectUri?: string; + oidcTrustedEndpoint?: boolean; + oidcIdTokenAsAccessToken?: boolean; + oidcDumpTokens?: boolean | 'redacted' | 'include-secrets'; + + OIDC auth options: + + --oidcFlows[=auth-code,device-auth] Supported OIDC auth flows + --oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect] + --oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint + --oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth + --oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets] + DB Address Examples: foo Foo database on local machine diff --git a/packages/cli-repl/README.md b/packages/cli-repl/README.md index 94d30e421..b86e57ea4 100644 --- a/packages/cli-repl/README.md +++ b/packages/cli-repl/README.md @@ -69,6 +69,20 @@ of mongosh, visit https://www.mongodb.com/try/download/shell. --keyVaultNamespace [arg] database.collection to store encrypted FLE parameters --kmsURL [arg] Test parameter to override the URL of the KMS endpoint + oidcFlows?: string; + oidcRedirectUri?: string; + oidcTrustedEndpoint?: boolean; + oidcIdTokenAsAccessToken?: boolean; + oidcDumpTokens?: boolean | 'redacted' | 'include-secrets'; + + OIDC auth options: + + --oidcFlows[=auth-code,device-auth] Supported OIDC auth flows + --oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect] + --oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint + --oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth + --oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets] + DB Address Examples: foo Foo database on local machine diff --git a/packages/mongosh/README.md b/packages/mongosh/README.md index 6d71da411..125320cf8 100644 --- a/packages/mongosh/README.md +++ b/packages/mongosh/README.md @@ -73,6 +73,20 @@ of mongosh, visit https://www.mongodb.com/try/download/shell. --keyVaultNamespace [arg] database.collection to store encrypted FLE parameters --kmsURL [arg] Test parameter to override the URL of the KMS endpoint + oidcFlows?: string; + oidcRedirectUri?: string; + oidcTrustedEndpoint?: boolean; + oidcIdTokenAsAccessToken?: boolean; + oidcDumpTokens?: boolean | 'redacted' | 'include-secrets'; + + OIDC auth options: + + --oidcFlows[=auth-code,device-auth] Supported OIDC auth flows + --oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect] + --oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint + --oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth + --oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets] + DB Address Examples: foo Foo database on local machine