招待状の作成
名前空間: microsoft.graph
この API を使用して、新しい 招待状 を作成します。招待状によって外部ユーザーが組織に追加されます。
新しい招待状を作成するときに、選択可能ないくつかのオプションがあります。
- 招待状の作成に際して、Microsoft Graph は自動的に招待メールを招待ユーザーに直接送信できます。作成応答で返された inviteRedeemUrl をアプリが使用して、招待ユーザーへの (任意の通信メカニズムによる) 独自の招待状を作成することもできます。Microsoft Graph によって招待メールが自動的に送信されるようにする場合は、invitedUserMessageInfo を使用してメールの内容と言語を制御できます。
- ユーザーが招待されると、(userType Guest) のユーザー エンティティが作成され、リソースへのアクセスの制御に使用できるようになります。 招待ユーザーは、招待されたリソースにアクセスするためには、引き換え処理を行う必要があります。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | User.Invite.All、User.ReadWrite.All、Directory.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 |
アプリケーション | User.Invite.All、User.ReadWrite.All、Directory.ReadWrite.All |
HTTP 要求
POST /invitations
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。必須。 |
Content-Type | application/json |
要求本文
要求本文で、invitation オブジェクトの JSON 表記を指定します。
次の表に、招待状の作成時に必要になるプロパティを示します。
パラメーター | 型 | 説明 |
---|---|---|
invitedUserEmailAddress | string | 招待するユーザーのメール アドレス。 |
inviteRedirectUrl | string | 引き換え後にユーザーがリダイレクトされる URL。 |
応答
成功した場合、このメソッドは 201 Created
応答コードと、応答本文で invitation オブジェクトを返します。
例
要求
要求の例を次に示します。
POST https://graph.microsoft.com/v1.0/invitations
Content-type: application/json
{
"invitedUserEmailAddress": "admin@fabrikam.com",
"inviteRedirectUrl": "https://myapp.contoso.com"
}
応答
応答の例を次に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#invitations/$entity",
"id": "7b92124c-9fa9-406f-8b8e-225df8376ba9",
"inviteRedeemUrl": "https://invitations.microsoft.com/redeem/?tenant=04dcc6ab-388a-4559-b527-fbec656300ea&user=7b92124c-9fa9-406f-8b8e-225df8376ba9&ticket=VV9dmiExBsfRIVNFjb9ITj9VXAd07Ypv4gTg%2f8PiuJs%3d&lc=1033&ver=2.0",
"invitedUserDisplayName": "Fabrikam Admin",
"invitedUserEmailAddress": "admin@fabrikam.com",
"sendInvitationMessage": false,
"invitedUserMessageInfo": {
"messageLanguage": null,
"ccRecipients": [
{
"emailAddress": {
"name": null,
"address": null
}
}
],
"customizedMessageBody": null
},
"inviteRedirectUrl": "https://myapp.contoso.com",
"status": "Completed",
"invitedUser": { "id": "243b1de4-ad9f-421c-a933-d55305fb165d" }
}
フィードバック
フィードバックの送信と表示