招待リソースの種類

名前空間: microsoft.graph

重要

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

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

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

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

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

注:

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

メソッド

メソッド 戻り値の型 説明
Create invitation 招待オブジェクトを作成します。

プロパティ

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

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

リレーションシップ

リレーションシップ 型 説明
invitedUser user 招待状作成の一環として作成されたユーザー。 読み取り専用です。 id プロパティは 、引き換え状態をリセットするために要求本文に必要です。
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"
}
  • Last updated on