Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
組織とチーム
/
チーム

チームにユーザーを追加する

項目一覧

  • 構文
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

構文

POST /orgs/{ORG-ID}/teams/{TEAM-ID}/users

リクエスト パス パラメーター

path 要素
必須/オプション
説明

ORG-ID

必須。

チームを関連付けたい組織の一意の識別子。

TEAM-ID

必須

ユーザーを追加するチームの名前。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

リクエスト ボディ パラメータ

チームに追加する 1 人のユーザーを表すドキュメントの配列を指定します。 配列内の各ドキュメントには、次のフィールドが含まれている必要があります。

名前
タイプ
説明

id

string

チームに追加するユーザーの一意の ID

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

result配列の各要素は、チームに追加された 1 人のユーザーです。

名前
タイプ
説明

country

string

ISO3166 -2 ユーザーに関連付けられた 国コード 。

emailAddress

string

ユーザーに関連付けられているメールアドレス。

firstName

string

ユーザーの名。

id

string

チームの一意の識別子。

lastName

string

ユーザーの姓。

links

配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

mobileNumber

string

ユーザーに関連付けられた電話番号。

roles

配列

roles配列内の各オブジェクトは、関連付けられたorg_idに対してユーザーが持つ MongoDB Atlas組織ロールを表します

roles.orgId

string

割り当てられたroles.roleName組織ロールを持つユーザーが割り当てられた組織の ID。

roles.roleName

string

指定されたroles.orgIdのユーザーに割り当てられた組織ロール。

teamsId

配列

配列内の各stringは、ユーザーに関連付けられたチームです。

username

string

ユーザーに関連付けられたユーザー名。

リクエストの例

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users? pretty=true" \
     --data '[{ "id" : "{USER-ID}" }]'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
 "links": [
     {
      "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true",
      "rel": "self"
     }
 ],
 "results": [
     {
      "country": "US",
      "emailAddress": "JohnDoe@example.com",
      "firstName": "John",
      "id": "{USER-ID}",
      "lastName": "Doe",
      "links": [
          {
              "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
              "rel": "self"
          }
      ],
      "mobileNumber": "5555550100",
      "roles": [
          {
              "orgId": "{ORG-ID}",
              "roleName": "ORG_MEMBER"
          },
          ...
      ],
      "teamIds": [ "{TEAM-ID}" ],
      "username": "JohnDoe@example.com"
     }
 ],
 "totalCount": 1
}

戻る

1 つのプロジェクトでのチームのロール更新

次へ

ユーザーを削除する