招待リソースの種類

[アーティクル]
10/18/2023

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ビジネス間 (Microsoft Entra B2B) コラボレーションの一環として外部ユーザーをorganizationに追加するために使用Microsoft Entra招待を表します。

招待処理では、次のフローが使用されます。

招待状が作成されます。
招待状が招待ユーザーに送信されます (招待状リンクを含む)。
招待されたユーザーが招待リンクを選択し、サインインして招待を引き換え、招待されたユーザーを表すユーザーエンティティの作成が完了します
引き換えが完了した後、特定のページにユーザーがリダイレクトされます。

招待を作成すると、応答 (inviteRedeemUrl) に引き換え URL が返されます。招待状作成 API では、sendInvitationMessage を true に設定することにより、引き換え URL を含むメールが自動的に招待ユーザーに送信されます。招待されたユーザーに送信されるメッセージをカスタマイズすることもできます。代わりに、他の手段で引き換え URL を送信したい場合は、sendInvitationMessage を false に設定し、応答からの引き換え URL を使用して、独自の通信を作成することもできます。現在、引き換えプロセスを実行する API はありません。招待されたユーザーは、上記の手順で通信で送信された inviteRedeemUrl リンクを選択し、ブラウザーで対話型の引き換えプロセスを実行する必要があります。完了すると、招待ユーザーは、組織における外部ユーザーになります。

注:

招待の状態は、招待要求の一部として作成された外部ユーザーリソースの externalUserState と externalUserStateChangeDateTime プロパティを使用して追跡されます。

メソッド

メソッド	戻り値の型	説明
招待状の作成	invitation	招待状オブジェクトのプロパティと関係を書き込みます。

プロパティ

プロパティ	型	説明
invitedUserDisplayName	String	招待されるユーザーの表示名。
invitedUserEmailAddress	String	招待されるユーザーのメールアドレス。必須です。メールアドレスでは、次の特殊文字は使用できません。チルダ (~) 感嘆符 (`!`) アットマーク (`@`) シャープ記号 (`#`) ドル記号 (`$`) パーセント (`%`) サーカムフレクス (`^`) アンパサンド (`&`) アスタリスク (`*`) かっこ (`( )`) ハイフン (`-`) 正符号 (`+`) 等号 (`=`) ブラケット (`[ ]`) 波かっこ (`{ }`) 円記号 (`\`) スラッシュ (`/`) パイプ (`\|`) セミコロン (`;`) コロン (`:`) 引用符 (`"`) 山かっこ (`< >`) 疑問符 (`?`) カンマ (`,`) ただし、次の例外があります。ピリオド (`.`) またはハイフン (`-`) は、ユーザー名の先頭または末尾を除き、どこでも使用できます。アンダースコア (`_`) は、ユーザー名のどこでも使用できます。これには、名前の先頭または末尾が含まれます。
invitedUserMessageInfo	invitedUserMessageInfo	メッセージテキスト、言語、および cc 受信者リストのカスタマイズなど、招待ユーザーに送信されるメッセージの追加構成。
inviteRedirectUrl	String	招待状が引き換えられるとにユーザーがリダイレクトされる URL。必須。
inviteRedeemUrl	String	ユーザーが招待状の引き換えに使用できる URL。読み取り専用です。
invitedUserType	String	招待されるユーザーの userType。既定では `Guest` です。会社の管理者である `Member` かのように招待できます。既定値は `false` です。
resetRedemption	ブール型	ユーザーの引き換え状態をリセットし、ユーザー識別子、グループメンバーシップ、アプリの割り当てを保持したまま、ユーザーを再招待します。このプロパティを使用すると、ユーザーが以前の招待とは異なるメールアドレスを使用してサインインできるようにします。このプロパティの使用方法の詳細については、「ゲストユーザーの引き換え状態をリセットする (プレビュー)」を参照してください。
sendInvitationMessage	Boolean	招待されるユーザーにメールを送信するかどうかを示します。既定値は `false` です。
status	String	招待の状態。使用可能な値: `PendingAcceptance`、、 `Completed`、 `InProgress`および `Error`

リレーションシップ

リレーションシップ	型	説明
invitedUser	user	招待状作成の一環として作成されたユーザー。読み取り専用
invitedUserSponsors	directoryObject コレクション	招待されたユーザーのスポンサーであるユーザーまたはグループ。スポンサーは、テナント内のゲストユーザーの特権を担当し、ゲストユーザーの情報とアクセスを最新の状態に保つユーザーとグループです。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "id": "String",
  "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"
}