1 つのプロジェクトのすべてのデータベースユーザーを返す

GET /api/atlas/v2/groups/{groupId}/databaseUsers

指定されたプロジェクトに属するすべてのデータベースユーザーを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

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

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

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • includeCount ブール値

    レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。

    デフォルト値はtrueです。

  • itemsPerPage integer

    レスポンスが返す 1 ページあたりのアイテムの数。

    最小値は 1、最大値は 500 です。デフォルト値は 100 です。

  • pageNum integer

    レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

    の最小値は 1 です。デフォルト値は 1 です。

  • pretty ブール値

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

    デフォルト値はfalseです。

    Prettyprint

応答

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

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 結果 array[オブジェクト]

      このリクエストの完了時にMongoDB Cloud が提供する返されたドキュメントのリスト。

      結果属性を非表示にする 結果属性の表示 オブジェクト
      • awsIAMType string

        新しいデータベースユーザーが、ユーザーに関連付けられた AWS(Amazon Web Services)の IAM(Identity and Access Management、ID とアクセス管理)認証情報で認証されるか、またはユーザーのロールで認証されるを示す、人間が判読可能なラベル。

        値は NONEUSER、または ROLE です。デフォルト値は NONE です。

      • databaseName string 必須

        データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

        値は admin または $external です。デフォルト値は admin です。

      • deleteAfterDate string(date-time)

        MongoDB Cloud がユーザーを削除する日時。このパラメーターは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、タイム ゾーンの指定を含めることができます。API(Application Programming Interface、アプリケーション プログラミング インターフェース)要求を行ってから 1 週間以内の未来の日付を指定する必要があります。

      • 説明 string

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

        最大長は 100 です。

      • labels array[オブジェクト]

        MongoDB データベース ユーザーをタグ付けおよび分類するためのキーと値のペアが格納されたリスト。定義したラベルはコンソールに表示されません。

        このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。

        ラベル属性を非表示 ラベル属性の表示 オブジェクト
        • キー string

          このコンポーネントをタグ付けおよび分類するために適用されるキー。

          最小長は 1、最大長は 255 です。

        • 価値 string

          このコンポーネントをタグ付けおよび分類するために適用されるキーに設定された値。

          最小長は 1、最大長は 255 です。

      • ldapAuthType string

        データベースが LDAP(Lightweight Directory Access Protocol、ライトウェイト ディレクトリ アクセス プロトコル)のホスト上でこのデータベースユーザーを認証するために使用する LDAP レコードの一部。

        値は NONEGROUP、または USER です。デフォルト値は NONE です。

      • oidcAuthType string

        新しいデータベースユーザーまたはグループが OIDC フェデレーション認証で認証されるかどうかを示す、人間が判読可能なラベル。フェデレーション認証ユーザーを作成するには、このフィールドに USER の値を指定します。フェデレーション認証グループを作成するには、このフィールドに IDP_GROUP の値を指定します。

        値は NONEIDP_GROUP、または USER です。デフォルト値は NONE です。

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

        1 つのロールと適用される 1 つのデータベースの組み合わせを提供するリスト。

        このデータベースユーザーが利用できるリソースの範囲。

        ロール属性を非表示にする ロール属性の表示 オブジェクト
        • コレクション名 string

          このロールが適用されるコレクション。

        • databaseName string 必須

          ユーザーがアクセス特権を付与されるデータベース。

        • roleName string 必須

          データベースユーザーに割り当てられた特権のグループを識別する、人間が判読可能なラベル。この値は、 組み込みロール またはカスタムロールにすることができます。

          値は、atlasAdminbackupclusterMonitordbAdmindbAdminAnyDatabaseenableShardingreadreadAnyDatabasereadWritereadWriteAnyDatabase、または <a custom role name> です。

      • scopes array[オブジェクト]

        このデータベース ユーザーがアクセスできるクラスター、MongoDB Atlas Data Lake、MongoDB Atlas Streams インスタンスが格納されたリスト。省略した場合、MongoDB Cloud はデータベースユーザーに、プロジェクト内のすべてのクラスター、MongoDB Atlas Data Lakes、MongoDB Atlas Streams インスタンスへのアクセスを許可します。

        このデータベースユーザーが利用できるリソースの範囲。

        スコープ属性を非表示にする スコープ属性の表示 オブジェクト
        • name string 必須

          このデータベースユーザーがアクセスできるクラスターまたはMongoDB Atlas Data Lakeを識別する、人間が判読可能なラベル。

          形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

        • タイプ string 必須

          このデータベースユーザーがアクセスできるリソースのカテゴリ。

          値は CLUSTERDATA_LAKE、または STREAM です。

      • username string 必須

        MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

        認証方法 必要なパラメーター パラメーターの値 username のフォーマット
        AWS IAM awsIAMType ROLE ARN
        AWS IAM awsIAMType USER ARN
        x.509 x509Type CUSTOMER RFC2253 識別名
        x.509 x509Type MANAGED RFC2253 識別名
        LDAP ldapAuthType USER RFC2253 識別名
        LDAP ldapAuthType GROUP RFC2253 識別名
        OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID(フェデレーション設定で確認可能)、その後に「/」、その後に IdP グループ名が続きます
        OIDC Workload oidcAuthType USER Atlas OIDC IdP ID(フェデレーション設定で確認可能)、その後に「/」が続き、その後に IdP ユーザー名が続きます
        SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列

        最大長は 1024 です。

      • x509Type string

        MongoDB Cloud がデータベースユーザーの認証に使用する X.509 方式。

        • アプリケーション管理 X.509 の場合は、MANAGED を指定します。
        • 自己管理型 X.509 の場合は、CUSTOMER を指定します。

        CUSTOMER メソッドで作成されたユーザーには、ユーザー名パラメーターに CN(Common Name、共通名)が必要です。$external データベースに外部認証ユーザーを作成する必要があります。

        値は NONECUSTOMER、または MANAGED です。デフォルト値は NONE です。

    • totalCount integer(int32)

      使用可能なドキュメントの合計数。includeCountfalse に設定されている場合、 MongoDB Cloud はこの値を省略します。合計数は推定値であり、正確でない場合があります。

      の最小値は 0 です。

  • 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

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

atlas api databaseUsers listGroupDatabaseUsers --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.ListGroupDatabaseUsersApiParams{}
	sdkResp, httpResp, err := client.DatabaseUsersApi.
		ListGroupDatabaseUsersWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
応答の例(200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "awsIAMType": "NONE",
      "databaseName": "admin",
      "deleteAfterDate": "2025-05-04T09:42:00Z",
      "description": "string",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "ldapAuthType": "NONE",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "oidcAuthType": "NONE",
      "roles": [
        {
          "collectionName": "string",
          "databaseName": "string",
          "roleName": "atlasAdmin"
        }
      ],
      "scopes": [
        {
          "name": "string",
          "type": "CLUSTER"
        }
      ],
      "username": "string",
      "x509Type": "NONE"
    }
  ],
  "totalCount": 42
}
応答の例(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"
}