招待リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
組織に外部ユーザーを追加するために使用される招待を表します。
招待処理では、次のフローが使用されます。
- 招待状が作成されます。
- 招待状が招待ユーザーに送信されます (招待状リンクを含む)。
- 招待ユーザーが招待状リンクをクリックしてサインインし、招待状を引き換え、招待ユーザーを表すユーザー エンティティの作成が完了します。
- 引き換えが完了した後、特定のページにユーザーがリダイレクトされます。
招待状を作成すると、応答で引き換え URL が返されます (inviteRedeemUrl)。招待状作成 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 | Boolean | ユーザー ID、グループ メンバーシップ、およびアプリの割り当てを保持しながら、ユーザーの引き換え状態をリセットし、ユーザーを再入力します。 このプロパティを使用すると、ユーザーが前の招待のメール アドレスとは異なる電子メール アドレスを使用してサインインできます。 このプロパティの使用の詳細については、「ゲスト ユーザーの引き換え状態のリセット (プレビュー)」を参照してください。 |
| sendInvitationMessage | Boolean | 招待されるユーザーにメールを送信するかどうかを示します。 既定値は false です。 |
| status | String | 招待の状態。 指定できる値: PendingAcceptance Completed InProgress 、、 Error |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| invitedUser | user | 招待状作成の一環として作成されたユーザー。読み取り専用 |
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"
}
フィードバック
フィードバックの送信と表示