1 つのチームに割り当てられたすべての MongoDB Cloud ユーザーを返す
組織内の指定されたチームに関連付けられている、保留中の MongoDB Cloud ユーザーおよびアクティブな MongoDB Cloud ユーザーの詳細を返します。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織メンバーのロールが必要です。
注: このリソースは、非推奨の「1 人の MongoDB Cloud ユーザーを 1 つのプロジェクトに招待する」エンドポイントとなる接続されたデバイスを介して招待されたユーザーの詳細を表示するために使用することはできません。
注意: 保留中のユーザーとアクティブなユーザーの両方を返すには、v2-{2025-02-19} 以降を使用してください。非推奨のバージョンを使用している場合、アクティブなユーザーのみが帰されます。非推奨バージョン: v2-{2023-01-01}
path パラメータ
-
24プロジェクトを含む組織を識別する一意の 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
アプリケーション ユーザーを返したいチームを識別する、ユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1、最大値は500です。デフォルト値は100です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1です。デフォルト値は1です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
ユーザーをフィルターするためのメール アドレスです。非推奨バージョンではサポートされていません。
-
ユーザーをフィルターするための組織メンバーシップ ステータス。このパラメータを除外すると、このリソースは保留中のユーザーとアクティブなユーザーの両方を返します。非推奨バージョンではサポートされていません。
-
ユーザーをフィルタリングする一意の 24 桁の 16 進数文字列。 非推奨バージョンではサポートされていません。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
atlas api mongoDbCloudUsers listOrgTeamUsers --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250219001/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.ListOrgTeamUsersApiParams{}
sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
ListOrgTeamUsersWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"id": "32b6e34b3d91647abb20e7b8",
"orgMembershipStatus": "PENDING",
"roles": {
"groupRoleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"groupRoles": [
"GROUP_OWNER"
]
}
],
"orgRoles": [
"ORG_OWNER"
]
},
"teamIds": [
"32b6e34b3d91647abb20e7b8"
],
"username": "hello@example.com",
"invitationCreatedAt": "2025-05-04T09:42:00Z",
"invitationExpiresAt": "2025-05-04T09:42:00Z",
"inviterUsername": "hello@example.com"
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}