ベース URL: https://cloud.mongodb.com/api/public/v1.0
構文
POST /orgs/{ORG-ID}/teams/{TEAM-ID}/usersリクエスト パス パラメーター
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
チームに追加する 1 人のユーザーを表すドキュメントの配列を指定します。 配列内の各ドキュメントには、次のフィールドが含まれている必要があります。
名前 | タイプ | 説明 |
|---|---|---|
| string | チームに追加するユーザーの一意の ID |
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
result配列の各要素は、チームに追加された 1 人のユーザーです。
名前 | タイプ | 説明 |
|---|---|---|
| string | ユーザーに関連付けられた ISO3166 - 国コード。2 |
| string | ユーザーに関連付けられているメールアドレス。 |
| string | ユーザーの名。 |
| string | チームの一意の識別子。 |
| string | ユーザーの姓。 |
| 配列 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
| string | ユーザーに関連付けられた電話番号。 |
| 配列 |
|
| string | 割り当てられた |
| string | 指定された |
| 配列 | 配列内の各stringは、ユーザーに関連付けられたチームです。 |
| 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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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}