Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
ツール
/
Atlas CLI
/
Atlas CLI
/
コマンド

Atlas API databaseUser createDatabaseUser

パブリック プレビュー: にフィードバックを提供してください: 指定されたプロジェクトに 1 人のデータベースユーザーを作成します。

このMongoDB Cloud は、プロジェクトごとに最大 100 のデータベースユーザーをサポートします。プロジェクトで 100 を超えるデータベースユーザーが必要な場合は、 サポート にお問い合わせください。このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Charts 管理者ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/#tags/Database-ユーザー/操作/createDatabaseUser を実行します。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文
atlas api databaseUsers createDatabaseUser [options]

オプション

名前
タイプ
必須
説明

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--file

string

false

APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

createDatabaseUser のヘルプ

--出力

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- output-file

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。

--pretty

false

レスポンス本体を <aクエリを実行するかどうかを示すフラグtarget ` ` Sharding</a>

--version

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

継承されたオプション

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

例

LDAP 認証

以下のファイルを作成し、保存します payload.json

{
  "databaseName": "admin",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "ldapAuthType": "GROUP",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "CN=marketing,OU=groups,DC=example,DC=com"
}

payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false

OIDC ワークフォース フェデレーション認証

以下のファイルを作成し、保存します payload.json

{
  "databaseName": "admin",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "oidcAuthType": "IDP_GROUP",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "5dd7496c7a3e5a648454341c/sales"
}

payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false

OIDC ワークロード フェデレーション認証

以下のファイルを作成し、保存します payload.json

{
  "databaseName": "$external",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "oidcAuthType": "USER",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "5dd7496c7a3e5a648454341c/sales"
}

payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false

SCRAM-SHA 認証

以下のファイルを作成し、保存します payload.json

{
  "databaseName": "admin",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "password": "changeme123",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "david"
}

payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false

X509 認証

以下のファイルを作成し、保存します payload.json

{
  "databaseName": "$external",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "CN=david@example.com,OU=users,DC=example,DC=com",
  "x509Type": "CUSTOMER"
}

payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false

項目一覧