Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
プロジェクトとユーザー
/
プロジェクト

すべてのプロジェクトの招待を取得する

項目一覧

  • 必須のロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

指定した Cloud Manager プロジェクトに対するすべての保留中の招待を検索します。

必須のロール

Project User Adminロールを使用して、このエンドポイントを正常に呼び出すことができます。

Resource

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

GET /groups/{GROUP-ID}/invites

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

path 要素
タイプ
必要性
説明

グループ ID

string

必須

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

username

string

任意

招待されたユーザーのメールアドレス。 これは、Cloud Manager が招待を送信したアドレスです。

省略すると、Cloud Manager はすべての保留中の招待を返します。

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答JSONドキュメントには、オブジェクトの配列が含まれます。 各オブジェクトは、Cloud Manager プロジェクトへの 1 回の招待を表します。

名前
タイプ
説明

createdAt

string

ISO8601 のタイムスタンプ Cloud Manager が招待を送信したときの UTC の日時形式。

expiresAt

string

ISO8601 のタイムスタンプ 招待の有効期限が切れる UTC の日時形式。

Cloud Manager プロジェクトへの招待を承諾するには、ユーザーは 30 日間があります。

グループ ID

string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

groupName

string

プロジェクトの名前。

id

string

招待を識別するユニークな 24 桁の 16 進数の文字列。

inviterUsername

string

ユーザー名をプロジェクトに招待した Cloud Manager ユーザー。

役割

文字列の配列

招待されたユーザーに割り当てる Cloud Managerロール。

ユーザーが招待を承諾した場合、Cloud Manager はこれらのロールをユーザーに割り当てます。

username

string

Cloud Manager が招待を送信したメールアドレス。

ユーザーが招待を承諾した場合、Cloud Manager のユーザー名としてこのメールアドレスを使用します。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true"

応答例

応答ヘッダー

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}

レスポンス本体

1[
2  {
3    "createdAt": "2021-02-18T18:51:46Z",
4    "expiresAt": "2021-03-20T18:51:46Z",
5    "groupId": "{GROUP-ID}",
6    "groupName": "group",
7    "id": "{INVITATION-ID}",
8    "inviterUsername": "admin@example.com",
9    "roles": [
10      "GROUP_OWNER"
11    ],
12    "username": "jane.smith@example.com"
13  },
14  {
15    "createdAt": "2021-02-18T21:05:40Z",
16    "expiresAt": "2021-03-20T21:05:40Z",
17    "groupId": "{GROUP-ID}",
18    "groupName": "group",
19    "id": "{INVITATION-ID}",
20    "inviterUsername": "admin@example.com",
21    "roles": [
22      "GROUP_READ_ONLY"
23    ],
24    "username": "john.smith@example.com"
25  }
26]

戻る

削除招待

次へ

招待を 1 つ受け取る