名前空間: microsoft.graph
Microsoft Entra 外部 IDでのビジネス間 (B2B) コラボレーションの一環として、外部ユーザーをorganizationに追加するために使用される招待を表します。
招待処理では、次のフローが使用されます。
- 招待が作成されます。
- 招待リンクを含む招待が招待されたユーザーに送信されます。
- 招待されたユーザーが招待リンクを選択し、サインインして招待を引き換え、招待されたユーザーを表すユーザー エンティティが作成されます。
- 引き換えが完了すると、ユーザーは特定のページにリダイレクトされます。
招待を作成すると、応答 (inviteRedeemUrl) に引き換え URL が返されます。 招待の作成 API は、 sendInvitationMessage を true に設定することで、招待されたユーザーに引き換え URL を含む電子メールを自動的に送信できます。 招待されたユーザーに送信されるメッセージをカスタマイズすることもできます。 代わりに、他の方法で引き換え URL を送信する場合は、 sendInvitationMessage を false に設定し、応答から引き換え URL を使用して独自の通信を作成できます。 現時点では、引き換えプロセスを実行するための API は使用できません。 招待されたユーザーは、通信で送信された inviteRedeemUrl リンクを選択し、ブラウザーで対話型の引き換えプロセスを実行する必要があります。 プロセスが完了すると、招待されたユーザーはorganizationの外部ユーザーになります。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | invitation | 招待オブジェクトを作成します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| invitedUserDisplayName | String | 招待されるユーザーの表示名。 |
| invitedUserEmailAddress | String | 招待されるユーザーのメール アドレス。 必須です。 メール アドレスでは、次の特殊文字は使用できません。
ただし、次の例外があります。
|
| invitedUserMessageInfo | invitedUserMessageInfo | メッセージ テキスト、言語、cc 受信者リストのカスタマイズなど、招待されたユーザーに送信されるメッセージの構成が含まれます。 |
| invitedUserType | String | 招待されるユーザーの userType。 既定では Guest です。 会社の管理者であれば、 Member として招待できます。 |
| inviteRedirectUrl | 文字列 | 招待を引き換えた後にユーザーがリダイレクトする必要がある URL。 必須です。 |
| inviteRedeemUrl | String | ユーザーが招待状の引き換えに使用できる URL。 読み取り専用です。 |
| resetRedemption | ブール型 | ユーザーの引き換え状態をリセットし、ユーザー識別子、グループ メンバーシップ、アプリの割り当てを保持したまま、ユーザーを再招待します。 このプロパティを使用すると、ユーザーが以前の招待とは異なるメール アドレスを使用してサインインできるようにします。
true場合は、invitedUser/id リレーションシップが必要です。 このプロパティの使用の詳細については、「 ゲスト ユーザーの引き換え状態をリセットする」を参照してください。 |
| sendInvitationMessage | Boolean | 招待されるユーザーにメールを送信するかどうかを示します。 既定値は false です。 |
| status | String | 招待の状態。 使用可能な値は、 PendingAcceptance、 Completed、 InProgress、および Errorです。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| invitedUser | user | 招待状作成の一環として作成されたユーザー。 読み取り専用です。 引き換えの状態をリセットするには、要求本文で id プロパティが必要です。 |
| invitedUserSponsors | directoryObject コレクション | 招待されたユーザーのスポンサーであるユーザーまたはグループ。 スポンサーは、テナント内のゲスト ユーザーの特権を担当し、ゲスト ユーザーの情報とアクセスを最新の状態に保つユーザーとグループです。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"invitedUserDisplayName": "string",
"invitedUserEmailAddress": "string",
"invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
"sendInvitationMessage": false,
"inviteRedirectUrl": "string",
"inviteRedeemUrl": "string",
"resetRedemption": false,
"status": "string",
"invitedUser": {"@odata.type": "microsoft.graph.user"},
"invitedUserType": "string"
}