招待リソースの種類invitation resource type

組織に外部ユーザーを追加するために使用される招待を表します。Represents an invitation that is used to add external users to an organization.

招待処理では、次のフローが使用されます。The invitation process uses the following flow:

  • 招待状が作成されます。An invitation is created
  • 招待状が招待ユーザーに送信されます (招待状リンクを含む)。An invitation is sent to the invited user (containing an invitation link)
  • 招待ユーザーが招待状リンクをクリックしてサインインし、招待状を引き換え、招待ユーザーを表すユーザー エンティティの作成が完了します。The invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
  • 引き換えが完了した後、特定のページにユーザーがリダイレクトされます。The user is redirected to a specific page after redemption completes

招待状を作成すると、応答で引き換え URL が返されます (inviteRedeemUrl)。招待状作成 API では、sendInvitationMessage を true に設定することにより、引き換え URL を含むメールが自動的に招待ユーザーに送信されます。招待ユーザーに送信されるメッセージをカスタマイズすることもできます。代わりに、他の手段で引き換え URL を送信したい場合は、sendInvitationMessage を false に設定し、応答からの引き換え URL を使用して、独自の通信を作成することもできます。現在、引き換え処理を実行するための API はありません。招待ユーザーは、上記手順の通信で送信された inviteRedeemUrl リンクをクリックして、対話型引き換え処理をブラウザーで行う必要があります。完了すると、招待ユーザーは、組織における外部ユーザーになります。Creating an invitation will return a redemption URL in the response (inviteRedeemUrl). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the sendInvitationMessage to true. You can also customize the message that will be sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the sendInvitationMessage to false and use the redeem URL from the response to craft your own communication. Currently, there is no API to perform the redemption process. The invited user has to click on the inviteRedeemUrl link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
招待状の作成Create invitation invitationinvitation 招待状オブジェクトのプロパティと関係を書き込みます。Write properties and relationships of invitation object.

プロパティProperties

プロパティProperty Type 説明Description
invitedUserDisplayNameinvitedUserDisplayName StringString 招待されるユーザーの表示名。The display name of the user being invited.
invitedUserEmailAddressinvitedUserEmailAddress StringString 招待されるユーザーのメール アドレス。The email address of the user being invited. 必須です。Required. 次の特殊文字は、メール アドレスに使用できません:The following special characters are not permitted in the email address:
  • チルダ (~)Tilde (~)
  • 感嘆符 (!)Exclamation point (!)
  • アット マーク (@)At sign (@)
  • シャープ記号 (#)Number sign (#)
  • ドル記号 ($)Dollar sign ($)
  • パーセント (%)Percent (%)
  • サーカムフレクス (^)Circumflex (^)
  • アンパサンド (&)Ampersand (&)
  • アスタリスク (*)Asterisk (*)
  • かっこ (( ))Parentheses (( ))
  • ハイフン (-)hyphen (-)
  • 正符号 (+)Plus sign (+)
  • 等号 (=)Equal sign (=)
  • ブラケット ([ ])Brackets ([ ])
  • 波かっこ ({ })Braces ({ })
  • 円記号 (\)Backslash (\)
  • スラッシュ (/)Slash mark (/)
  • パイプ (|)Pipe (|)
  • セミコロン (;)Semicolon (;)
  • コロン (:)Colon (:)
  • 引用符 (")Quotation marks (")
  • 山かっこ (< >)Angle brackets (< >)
  • 疑問符 (?)Question mark (?)
  • カンマ (,)Comma (,)

ただし、次の例外があります。However, the following limitations apply:
  • ピリオド (.) またはハイフン (-) は、ユーザー名の先頭または末尾を除き、どこでも使用できます。A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.
  • アンダースコア (_) は、ユーザー名のどこでも使用できます。An underscore (_) is permitted anywhere in the user name. これには、名前の先頭または末尾が含まれます。This includes at the beginning or end of the name.
invitedUserMessageInfoinvitedUserMessageInfo invitedUserMessageInfoinvitedUserMessageInfo メッセージ テキスト、言語、および cc 受信者リストのカスタマイズなど、招待ユーザーに送信されるメッセージの追加構成。Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
sendInvitationMessagesendInvitationMessage BooleanBoolean 招待されるユーザーにメールを送信するかどうかを示します。既定値は false です。Indicates whether an email should be sent to the user being invited or not. The default is false.
inviteRedirectUrlinviteRedirectUrl StringString 招待状が引き換えられるとにユーザーがリダイレクトされる URL。必須。The URL user should be redirected to once the invitation is redeemed. Required.
inviteRedeemUrlinviteRedeemUrl StringString ユーザーが招待状の引き換えに使用できる URL。読み取り専用The URL user can use to redeem his invitation. Read-Only
invitedUserTypeinvitedUserType StringString 招待されるユーザーの userType。The userType of the user being invited. 既定では Guest です。By default, this is Guest. 会社の管理者の場合は、Member として招待できます。You can invite as Member if you are a company administrator.
statusstatus StringString 招待の状態。可能な値:PendingAcceptance、Completed、InProgress、および ErrorThe status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
invitedUserinvitedUser UserUser 招待状作成の一環として作成されたユーザー。読み取り専用The user created as part of the invitation creation. Read-Only

JSON 表記JSON representation

以下は、リソースの JSON 表記ですHere is a JSON representation of the resource

{
  "invitedUserDisplayName": "string",
  "invitedUserEmailAddress": "string",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "string",
  "inviteRedeemUrl": "string",
  "status": "string",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "string"
}