Atlas API チーム addTeamUser
Public Preview: please provide feedback at: Adds one or more MongoDB Cloud users from the specified organization to the specified team.
チームを使用すると、 MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。1 つの組織から最大 250 のMongoDB Cloud ユーザーを 1 つのチームに割り当てることができます。このリソースを使用するには、リクエストするAPIキーに組織所有者のロールが必要です。
注: このエンドポイントとなる接続されたデバイスは非推奨です。アクティブなユーザーまたは保留中のユーザーをチームに追加するには、「1 つのチームに 1 人の MongoDB Cloud ユーザーを追加」を使用します。
このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Teams/ /addTeamUser の操作を参照してください。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api teams addTeamUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--file | string | false | APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。 |
-h, --help | false | addTeamUser のヘルプ | |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | ||
--teamId | string | true | MongoDB Cloud ユーザーを追加するチームを識別するユニークな 24 進数文字列。 |
--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 を参照してください。 |