すべての組織の招待状を取得

項目一覧

必須のロール

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

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

指定した MongoDB Ops Manager 組織に対するすべての保留中の招待を検索します。

必須のロール

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

Resource

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

GET /orgs/{ORG-ID}/invites

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

path 要素	タイプ	必要性	説明
ORG-ID	string	必須	組織を識別する一意な 24 桁の 16 進数のstring 。

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

名前

タイプ

必要性

説明

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 進数の文字列。
inviterUsername	string	ユーザー名を組織に招待した MongoDB Ops Manager ユーザー。
orgId	string	組織を識別する一意な 24 桁の 16 進数のstring 。
orgName	string	組織名。
役割	文字列の配列	招待されたユーザーに割り当てる MongoDB Ops Manager ロール。ユーザーが招待を承諾した場合、MongoDB Ops Manager はこれらのロールをユーザーに割り当てます。
teamIds	文字列の配列	ユーザーが参加するように招待されたチームを識別する一意な 24 桁の 16 進数の文字列。
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/orgs/{ORG-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     "id": "{INVITATION-ID-1}",
6     "inviterUsername": "admin@example.com",
7     "orgId": "{ORG-ID}",
8     "orgName": "{ORG-NAME}",
9     "roles": [
10       "GROUP_OWNER"
11     ],
12     "teamIds": [],
13     "username": "jane.smith@example.com"
14   },
15   {
16     "createdAt": "2021-02-18T21:28:38Z",
17     "expiresAt": "2021-03-20T21:28:38Z",
18     "id": "{INVITATION-ID-2}",
19     "inviterUsername": "admin@example.com",
20     "orgId": "{ORG-ID}",
21     "orgName": "{ORG-NAME}",
22     "roles": [
23       "ORG_MEMBER"
24     ],
25     "teamIds": [],
26     "username": "john.smith@example.com"
27   },
28   {
29     "createdAt": "2021-02-18T21:05:40Z",
30     "expiresAt": "2021-03-20T21:05:40Z",
31     "id": "{INVITATION-ID-3}",
32     "inviterUsername": "admin@example.com",
33     "orgId": "{ORG-ID}",
34     "orgName": "{ORG-NAME}",
35     "roles": [
36       "ORG_MEMBER"
37     ],
38     "teamIds": [],
39     "username": "wyatt.smith@example.com"
40   }
41 ]

戻る

1 つの組織の招待状を削除

1 つの組織の招待状を取得

1	[
2	{
3	"createdAt": "2021-02-18T18:51:46Z",
4	"expiresAt": "2021-03-20T18:51:46Z",
5	"id": "{INVITATION-ID-1}",
6	"inviterUsername": "admin@example.com",
7	"orgId": "{ORG-ID}",
8	"orgName": "{ORG-NAME}",
9	"roles": [
10	"GROUP_OWNER"
11	],
12	"teamIds": [],
13	"username": "jane.smith@example.com"
14	},
15	{
16	"createdAt": "2021-02-18T21:28:38Z",
17	"expiresAt": "2021-03-20T21:28:38Z",
18	"id": "{INVITATION-ID-2}",
19	"inviterUsername": "admin@example.com",
20	"orgId": "{ORG-ID}",
21	"orgName": "{ORG-NAME}",
22	"roles": [
23	"ORG_MEMBER"
24	],
25	"teamIds": [],
26	"username": "john.smith@example.com"
27	},
28	{
29	"createdAt": "2021-02-18T21:05:40Z",
30	"expiresAt": "2021-03-20T21:05:40Z",
31	"id": "{INVITATION-ID-3}",
32	"inviterUsername": "admin@example.com",
33	"orgId": "{ORG-ID}",
34	"orgName": "{ORG-NAME}",
35	"roles": [
36	"ORG_MEMBER"
37	],
38	"teamIds": [],
39	"username": "wyatt.smith@example.com"
40	}
41	]