1 つのプロジェクト サービス アカウントのすべてのアクセス リスト エントリを返す

GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList

指定したプロジェクトのサービス アカウントに設定したすべてのアクセス リスト エントリを返します。

path パラメータ

  • グループ ID string 必須

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

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

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

  • clientId string 必須

    サービス アカウントのクライアント ID。

    形式は次のパターンと一致する必要があります: ^mdb_sa_id_[a-fA-F\d]{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.2024-08-05+json

    OK

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

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

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

        サービス アカウントのアクセス リスト内のネットワーク アドレスの範囲。 このパラメータでは、範囲をインターネット プロトコル バージョン4またはバージョン6アドレスの CIDR(Classless Inter-Domain Routing)表記で表現する必要があります。 このパラメータに値を設定することも、 ipAddressに値を設定することもできますが、同じリクエストで両方を設定することはできません。

        形式は次のパターンと一致する必要があります: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$

      • createdAt string(date-time)

        MongoDB Cloud が エントリを アクセス リスト に追加した日付です。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • ipAddress string

        サービス アカウントのアクセス リスト内のネットワーク アドレス。 このパラメータでは、アドレスを 1 つのインターネット プロトコル バージョン4またはバージョン6アドレスとして表現する必要があります。 このパラメータに値を設定することも、 cidrBlockに値を設定することもできますが、同じリクエストで両方を設定することはできません。

        形式は次のパターンと一致する必要があります: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$

      • lastUsedAddress string

        APIへの最新のリクエストを発行したネットワーク アドレス。このパラメータでは、アドレスを 1 つのインターネット プロトコル バージョン 4 またはバージョン 6 アドレスとして表現する必要があります。このIPアドレスが少なくとも 1 つのリクエストを行うと、リソースはこのパラメータを返します。

      • lastUsedAt string(date-time)

        MongoDB Cloud がこのインターネット プロトコル バージョン 4 またはバージョン 6 アドレスから送信された最新のリクエストを受信した日付。リソースは、少なくとも 1 つのリクエストがこのIPアドレスから発信された場合にこのパラメータを返します。 MongoDB Cloud は、クライアントが許可されたリソースにアクセスするたびにこのパラメータを更新し、最大 5 分の遅延で更新します。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • requestCount integer(int32)

        このネットワーク アドレスから送信されたリクエストの数。

    • 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

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

GET /api/atlas/v2 /groups/{groupId}/serviceAccounts/{clientId}/accessList を取得する
atlas api serviceAccounts listGroupServiceAccountAccessList --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/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.ListGroupServiceAccountAccessListApiParams{}
	sdkResp, httpResp, err := client.ServiceAccountsApi.
		ListGroupServiceAccountAccessListWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true"
応答の例(200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "cidrBlock": "203.0.113.0/24",
      "createdAt": "2025-05-04T09:42:00Z",
      "ipAddress": "203.0.113.10",
      "lastUsedAddress": "203.0.113.10",
      "lastUsedAt": "2025-05-04T09:42:00Z",
      "requestCount": 42
    }
  ],
  "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"
}