Skip to content

Commit

Permalink
chore: update CLI usage text (#2115)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] authored Aug 1, 2024
1 parent 781d1c9 commit c1e17f7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions packages/cli-repl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions packages/mongosh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c1e17f7

Please sign in to comment.