招待リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

組織に外部ユーザーを追加するために使用される招待を表します。

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

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

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

メソッド

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

プロパティ

プロパティ 型 説明
invitedUserDisplayName String 招待されるユーザーの表示名。
invitedUserEmailAddress String 招待されるユーザーのメール アドレス。 必須です。 次の特殊文字は、メール アドレスに使用できません:
  • チルダ (~)
  • 感嘆符 (!)
  • シャープ記号 (#)
  • ドル記号 ($)
  • パーセント (%)
  • サーカムフレクス (^)
  • アンパサンド (&)
  • アスタリスク (*)
  • かっこ (( ))
  • 正符号 (+)
  • 等号 (=)
  • ブラケット ([ ])
  • 波かっこ ({ })
  • 円記号 (\)
  • スラッシュ (/)
  • パイプ (\|)
  • セミコロン (;)
  • コロン (:)
  • 引用符 (")
  • 山かっこ (< >)
  • 疑問符 (?)
  • カンマ (,)

ただし、次の例外があります。
  • ピリオド (.) またはハイフン (-) は、ユーザー名の先頭または末尾を除き、どこでも使用できます。
  • アンダースコア (_) は、ユーザー名のどこでも使用できます。 これには、名前の先頭または末尾が含まれます。
invitedUserMessageInfo invitedUserMessageInfo メッセージ テキスト、言語、および cc 受信者リストのカスタマイズなど、招待ユーザーに送信されるメッセージの追加構成。
invitedUserType String 招待されるユーザーの userType。 既定では Guest です。 会社の管理者の場合は、Member として招待できます。
inviteRedirectUrl 文字列 招待が引き換えられたら、ユーザーがリダイレクトする必要がある URL。 必須です。
inviteRedeemUrl String ユーザーが招待状の引き換えに使用できる URL。 読み取り専用です。
resetRedemption ブール型 ユーザーの引き換え状態をリセットし、ユーザー識別子、グループ メンバーシップ、アプリの割り当てを保持したまま、ユーザーを再招待します。 このプロパティを使用すると、ユーザーが以前の招待とは異なるメール アドレスを使用してサインインできるようにします。 このプロパティの使用の詳細については、「 ゲスト ユーザーの引き換え状態をリセットする」を参照してください。
sendInvitationMessage Boolean 招待されるユーザーにメールを送信するかどうかを示します。 既定値は false です。
status String 招待の状態。 可能な値は、PendingAcceptance、Completed、InProgress、および Error です。

リレーションシップ

リレーションシップ 型 説明
invitedUser User 招待状作成の一環として作成されたユーザー。 読み取り専用

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"
}