Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

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

項目一覧

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

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

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

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{GROUP-ID}/invites
path 要素
タイプ
必要性
説明
グループ ID
string
必須
プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false
username
string
任意

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

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

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

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

名前
タイプ
説明
createdAt
string
ISO8601 のタイムスタンプ MongoDB Ops Manager が招待を送信したときの UTC の日付と時刻形式。
expiresAt
string

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

MongoDB Ops Manager プロジェクトへの招待を承諾するには 30 日間の制限があります。

グループ ID
string
プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
groupName
string
プロジェクトの名前。
id
string
招待を識別するユニークな 24 桁の 16 進数の文字列。
inviterUsername
string
ユーザー名をプロジェクトに招待した MongoDB Ops Manager ユーザー
役割
文字列の配列

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

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

username
string

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

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--request GET "https://opsmanager.example.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 つのプロジェクト招待を削除