Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas dbusers update

プロジェクト内のデータベースユーザーの詳細を変更します。

パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される atlas api サブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です( フィードバックでフィードバックを提供してくださいforwards/930808 -atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。

コマンド構文
atlas dbusers update <username> [options]
名前
タイプ
必須
説明

username

string

true

MongoDB database で更新するユーザー名。

名前
タイプ
必須
説明

--authDB

string

false

認証データベース名。 ユーザーがAmazon Web Services IAM、x.509、またはLDAPで認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA で認証される場合、この値は 管理者 である必要があります。

--desc

string

false

このデータベースユーザーの説明。

-h, --help

false

更新のヘルプ

-o, --output

string

false

出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。

-p, --password

string

false

データベースユーザーのパスワード。

--projectId

string

false

使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。

--role

string

false

ユーザーのロールと、そのロールが適用されるデータベースまたはコレクション。 このフラグを渡すと、既存のデータが置き換えられます。

--scope

string

false

このユーザーがアクセスできるクラスターの配列。 このフラグを渡すと、既存のデータが置き換えられます。

-u, --username

string

false

MongoDB への認証に使用するユーザー名。

--x509Type

string

false

指定されたユーザー名を認証するための X. 509メソッド。 有効な値には、None、MANAGED、および CUSTOMER が含まれます。 これを MANAGED に設定すると、ユーザーは Atlas が管理する X. 509証明書を使用して認証されます。 これを CUSTOMER に設定すると、ユーザーは自己管理型の X. 509証明書で認証されます。 この値のデフォルトは "None" です。

コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。

Successfully updated database user '<Username>'.
# Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3
# Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3

戻る

list

項目一覧