指定した Cloud Manager 組織に 1 人のユーザーを招待します。
Cloud Manager 組織にアクセスするには、ユーザーは招待を承諾する必要があります。
必須のロール
Organization User Adminロールを使用して、このエンドポイントを正常に呼び出すことができます。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v1.0
POST /orgs/{ORG-ID}/invites
リクエスト パス パラメーター
path 要素 | タイプ | 必要性 | 説明 |
|---|---|---|---|
ORG-ID | string | 必須 | 組織を識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
Body Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
役割 | 文字列の配列 | 必須 | 招待されたユーザーに割り当てる Cloud Managerロール。 ユーザーが招待を承諾した場合、Cloud Manager はこれらのロールをユーザーに割り当てます。 |
teamIds | 文字列の配列 | 任意 | ユーザーを招待したチームを識別する一意の24桁の 16 進数文字列。 |
username | string | 必須 | 招待されたユーザーのメールアドレス。 これは、Cloud Manager が招待を送信するアドレスです。 ユーザーが招待を承諾した場合は、このユーザー名で Cloud Manager にログインします。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation. |
expiresAt | string | Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Cloud Manager プロジェクトへの招待を承諾するには、ユーザーは 30 日間があります。 |
id | string | 招待を識別するユニークな 24 桁の 16 進数の文字列。 |
inviterUsername | string | ユーザー名を組織に招待した Cloud Manager ユーザー。 |
orgId | string | 組織を識別する一意な 24 桁の 16 進数のstring 。 |
orgName | string | 組織名。 |
役割 | 文字列の配列 | 招待されたユーザーに割り当てる Cloud Managerロール。 ユーザーが招待を承諾した場合、Cloud Manager はこれらのロールをユーザーに割り当てます。 |
teamIds | 文字列の配列 | ユーザーが参加するように招待されたチームを識別する一意な 24 桁の 16 進数の文字列。 |
username | string | Cloud Manager が招待を送信したメールアドレス。 ユーザーが招待を承諾した場合、Cloud Manager のユーザー名としてこのメールアドレスを使用します。 |
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true" \ 5 --data ' 6 { 7 "roles": [ 8 "ORG_MEMBER" 9 ], 10 "username": "wyatt.smith@example.com" 11 }'
応答例
応答ヘッダー
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
201 Created 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 "createdAt": "2021-02-18T21:05:40Z", 3 "expiresAt": "2021-03-20T21:05:40Z", 4 "id": "{INVITATION-ID}", 5 "inviterUsername": "admin@example.com", 6 "orgId": "{ORG-ID}", 7 "orgName": "{ORG-NAME}", 8 "roles": [ 9 "ORG_MEMBER" 10 ], 11 "teamIds": [], 12 "username": "wyatt.smith@example.com" 13 }