1 人のMongoDB クラウド ユーザーを作成 非推奨

POST /api/atlas/v2/users

MongoDB Cloud ユーザー アカウントを 1 つ作成します。MongoDB Cloud ユーザー アカウントは、MongoDB Cloud アプリケーションへのアクセスのみを許可します。データベースへのアクセスを許可するには、データベースユーザーを作成します。MongoDB Cloud は、指定されたユーザーにプロジェクトへの参加を招待するメールを送信します。招待されたユーザーは、招待を承諾するまでプロジェクトにアクセスできません。招待は 30 日後に期限切れになります。

MongoDB Cloud は、MongoDB Cloud ユーザーメンバーシップをチームあたり最大 250 人の MongoDB Cloud ユーザーに制限しています。MongoDB Cloud は、MongoDB Cloud ユーザーメンバーシップをプロジェクトあたり 500 人、組織あたり 500 人の MongoDB Cloud ユーザーに制限しており、これには組織内のすべてのプロジェクトの合計メンバーシップが含まれます。MongoDB Cloud では、操作がこれらの制限を超えるとエラーが発生します。たとえば、組織に 5 つのプロジェクトがあり、各プロジェクトに 100 人の MongoDB Cloud ユーザーがいて、各 MongoDB Cloud ユーザーが 1 つのプロジェクトにのみ属している場合、この組織に MongoDB Cloud ユーザーを追加することはできません。追加するには、まず既存の MongoDB Cloud ユーザーを組織から削除する必要があります。

このリソースは、リクエスト元のサービス アカウントまたは API キーがどのようなロールを持っていても使用できます。

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint
application/vnd.atlas.2023-01-01+json

body 必須

作成する MongoDB Cloud ユーザー アカウント。

  • string 必須

    MongoDB クラウドユーザーの地理的位置を示すアルファベット 2 文字。このパラメーターは ISO 3166-1a2 コード形式を使用します。

    形式は次のパターンと一致する必要があります: ^([A-Z]{2})$

  • string 必須

    MongoDB Cloud ユーザーの名。

  • string 必須

    MongoDB Cloud ユーザーの姓。

  • mobileNumber string 必須

    MongoDB Cloud ユーザーの携帯電話番号。

    形式は次のパターンと一致する必要があります: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$

  • パスワード string(パスワード) 必須

    MongoDB Cloud にログインするためにユーザー名に適用されるパスワード。MongoDB Cloud は、新しい MongoDB Cloud ユーザーの作成に応答する場合以外では、このパラメーターを返しません。MongoDB Cloud コンソールから設定したパスワードを更新できるのは MongoDB Cloud ユーザーだけです。

    最小長は 8 です。

  • 役割 array[オブジェクト]

    MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクトを表示するオブジェクトのリスト。ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。

    MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクト。各ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。

    ロール属性を非表示にする ロール属性の表示 オブジェクト
    • グループ ID string

      24このロールが属するプロジェクトを識別する一意の 桁の 16 進数文字列。このパラメータに値を設定することも、 orgId に値を設定することもできますが、 同じリクエストで両方を設定することはできません。

      最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • orgId string

      24このロールが属する組織を識別する一意の 桁の 16 進数文字列。このパラメータに値を設定することも、 groupId に値を設定することもできますが、 同じリクエストで両方を設定することはできません。

      最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • roleName string

      MongoDB Cloud が特定のAPIキー、 MongoDB Cloud ユーザー、またはMongoDB Cloudチーム に付与する権限のコレクションを識別する、人間に判読可能なラベル。これらのロールには、組織レベルとプロジェクト レベルのロールが含まれます。

      値は ORG_MEMBERORG_READ_ONLYORG_STREAM_PROCESSING_ADMINORG_BILLING_ADMINORG_BILLING_READ_ONLYORG_GROUP_CREATORORG_OWNERGROUP_OWNERGROUP_READ_ONLYGROUP_DATA_ACCESS_ADMINGROUP_DATA_ACCESS_READ_ONLYGROUP_DATA_ACCESS_READ_WRITEGROUP_CLUSTER_MANAGERGROUP_SEARCH_INDEX_EDITORGROUP_STREAM_PROCESSING_OWNERGROUP_BACKUP_MANAGERGROUP_OBSERVABILITY_VIEWER、または GROUP_DATABASE_ACCESS_ADMIN

  • username string(メール) 必須

    MongoDB Cloud ユーザーのユーザー名を表すメール アドレス。

応答

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • string 必須

      MongoDB クラウドユーザーの地理的位置を示すアルファベット 2 文字。このパラメーターは ISO 3166-1a2 コード形式を使用します。

      形式は次のパターンと一致する必要があります: ^([A-Z]{2})$

    • createdAt string(date-time)

      現在のアカウントが作成された日時。この値は、UTC の ISO 8601 タイムスタンプ形式です。

    • メールアドレス string(メール) 必須 非推奨

      MongoDB Cloud ユーザーのメール アドレス。

    • string 必須

      MongoDB Cloud ユーザーの名。

    • id string

      MongoDB Cloud ユーザーを識別するユニークな 24 桁の 16 進数文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • lastAuth string(date-time)

      現在のアカウントが最後に認証された日時。この値は、UTC の ISO 8601 タイムスタンプ形式です。

    • string 必須

      MongoDB Cloud ユーザーの姓。

    • mobileNumber string 必須

      MongoDB Cloud ユーザーの携帯電話番号。

      形式は次のパターンと一致する必要があります: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$

    • パスワード string(パスワード) 必須

      MongoDB Cloud にログインするためにユーザー名に適用されるパスワード。MongoDB Cloud は、新しい MongoDB Cloud ユーザーの作成に応答する場合以外では、このパラメーターを返しません。MongoDB Cloud コンソールから設定したパスワードを更新できるのは MongoDB Cloud ユーザーだけです。

      最小長は 8 です。

    • 役割 array[オブジェクト]

      MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクトを表示するオブジェクトのリスト。ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。

      MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクト。各ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。

      ロール属性を非表示にする ロール属性の表示 オブジェクト
      • グループ ID string

        24このロールが属するプロジェクトを識別する一意の 桁の 16 進数文字列。このパラメータに値を設定することも、 orgId に値を設定することもできますが、 同じリクエストで両方を設定することはできません。

        最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

      • orgId string

        24このロールが属する組織を識別する一意の 桁の 16 進数文字列。このパラメータに値を設定することも、 groupId に値を設定することもできますが、 同じリクエストで両方を設定することはできません。

        最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

      • roleName string

        MongoDB Cloud が特定のAPIキー、 MongoDB Cloud ユーザー、またはMongoDB Cloudチーム に付与する権限のコレクションを識別する、人間に判読可能なラベル。これらのロールには、組織レベルとプロジェクト レベルのロールが含まれます。

        値は ORG_MEMBERORG_READ_ONLYORG_STREAM_PROCESSING_ADMINORG_BILLING_ADMINORG_BILLING_READ_ONLYORG_GROUP_CREATORORG_OWNERGROUP_OWNERGROUP_READ_ONLYGROUP_DATA_ACCESS_ADMINGROUP_DATA_ACCESS_READ_ONLYGROUP_DATA_ACCESS_READ_WRITEGROUP_CLUSTER_MANAGERGROUP_SEARCH_INDEX_EDITORGROUP_STREAM_PROCESSING_OWNERGROUP_BACKUP_MANAGERGROUP_OBSERVABILITY_VIEWER、または GROUP_DATABASE_ACCESS_ADMIN

    • teamIds array[string]

      このMongoDB Cloud ユーザーが属するチームを識別する、一意の 24 桁の 16 進数文字列のリスト。

      各 の形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • username string(メール) 必須

      MongoDB Cloud ユーザーのユーザー名を表すメール アドレス。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

POST /api/atlas/v2 /users
atlas api mongoDbCloudUsers createUser --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateUserApiParams{}
	sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
		CreateUserWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'
リクエスト例
{
  "country": "string",
  "firstName": "string",
  "lastName": "string",
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "username": "hello@example.com"
}
応答の例(200)
{
  "country": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "emailAddress": "hello@example.com",
  "firstName": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com"
}
応答の例(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
応答の例(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
応答の例(404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
応答の例(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}