Skip to content

Commit c1e17f7

Browse files
chore: update CLI usage text (#2115)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 781d1c9 commit c1e17f7

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,20 @@ variable. For detailed instructions for each of our supported platforms, please
8484
--keyVaultNamespace [arg] database.collection to store encrypted FLE parameters
8585
--kmsURL [arg] Test parameter to override the URL of the KMS endpoint
8686

87+
oidcFlows?: string;
88+
oidcRedirectUri?: string;
89+
oidcTrustedEndpoint?: boolean;
90+
oidcIdTokenAsAccessToken?: boolean;
91+
oidcDumpTokens?: boolean | 'redacted' | 'include-secrets';
92+
93+
OIDC auth options:
94+
95+
--oidcFlows[=auth-code,device-auth] Supported OIDC auth flows
96+
--oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect]
97+
--oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint
98+
--oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth
99+
--oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets]
100+
87101
DB Address Examples:
88102
89103
foo Foo database on local machine

packages/cli-repl/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,20 @@ of mongosh, visit https://www.mongodb.com/try/download/shell.
6969
--keyVaultNamespace [arg] database.collection to store encrypted FLE parameters
7070
--kmsURL [arg] Test parameter to override the URL of the KMS endpoint
7171

72+
oidcFlows?: string;
73+
oidcRedirectUri?: string;
74+
oidcTrustedEndpoint?: boolean;
75+
oidcIdTokenAsAccessToken?: boolean;
76+
oidcDumpTokens?: boolean | 'redacted' | 'include-secrets';
77+
78+
OIDC auth options:
79+
80+
--oidcFlows[=auth-code,device-auth] Supported OIDC auth flows
81+
--oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect]
82+
--oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint
83+
--oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth
84+
--oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets]
85+
7286
DB Address Examples:
7387
7488
foo Foo database on local machine

packages/mongosh/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,20 @@ of mongosh, visit https://www.mongodb.com/try/download/shell.
7373
--keyVaultNamespace [arg] database.collection to store encrypted FLE parameters
7474
--kmsURL [arg] Test parameter to override the URL of the KMS endpoint
7575

76+
oidcFlows?: string;
77+
oidcRedirectUri?: string;
78+
oidcTrustedEndpoint?: boolean;
79+
oidcIdTokenAsAccessToken?: boolean;
80+
oidcDumpTokens?: boolean | 'redacted' | 'include-secrets';
81+
82+
OIDC auth options:
83+
84+
--oidcFlows[=auth-code,device-auth] Supported OIDC auth flows
85+
--oidcRedirectUri[=url] Local auth code flow redirect URL [http://localhost:27097/redirect]
86+
--oidcTrustedEndpoint Treat the cluster/database mongosh as a trusted endpoint
87+
--oidcIdTokenAsAccessToken Use ID tokens in place of access tokens for auth
88+
--oidcDumpTokens[=mode] Debug OIDC by printing tokens to mongosh's output [full|include-secrets]
89+
7690
DB Address Examples:
7791
7892
foo Foo database on local machine

0 commit comments

Comments
 (0)