Chilkat Online Tools

PowerBuilder / Microsoft Graph / Invite a guest user

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "invitedUserDisplayName": "<Display Name of Invited User>",
//   "invitedUserEmailAddress": "<Email Address of Invited User>",
//   "invitedUserMessageInfo": {
//     "messageLanguage": "en-US",
//     "ccRecipients": [
//       {
//         "emailAddress": {
//           "name": "<Optional CC for Invitation>",
//           "address": "<Optional CC Email Address for Invitation>"
//         }
//       }
//     ],
//     "customizedMessageBody": "Hi, you have just been invited to Azure AD with Postman using Microsoft Graph!"
//   },
//   "sendInvitationMessage": true,
//   "inviteRedirectUrl": "https://myapps.microsoft.com"
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("invitedUserDisplayName","<Display Name of Invited User>")
loo_Json.UpdateString("invitedUserEmailAddress","<Email Address of Invited User>")
loo_Json.UpdateString("invitedUserMessageInfo.messageLanguage","en-US")
loo_Json.UpdateString("invitedUserMessageInfo.ccRecipients[0].emailAddress.name","<Optional CC for Invitation>")
loo_Json.UpdateString("invitedUserMessageInfo.ccRecipients[0].emailAddress.address","<Optional CC Email Address for Invitation>")
loo_Json.UpdateString("invitedUserMessageInfo.customizedMessageBody","Hi, you have just been invited to Azure AD with Postman using Microsoft Graph!")
loo_Json.UpdateBool("sendInvitationMessage",1)
loo_Json.UpdateString("inviteRedirectUrl","https://myapps.microsoft.com")

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")

loo_Resp = loo_Http.PostJson3("https://graph.microsoft.com/v1.0/invitations","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{ 
    "invitedUserDisplayName": "<Display Name of Invited User>", 
    "invitedUserEmailAddress": "<Email Address of Invited User>", 
    "invitedUserMessageInfo": {
        "messageLanguage": "en-US",
        "ccRecipients": [
             {
                "emailAddress": {
                    "name": "<Optional CC for Invitation>",
                    "address": "<Optional CC Email Address for Invitation>"
                 }
             }
        ],
        "customizedMessageBody": "Hi, you have just been invited to Azure AD with Postman using Microsoft Graph!"
     },
    "sendInvitationMessage": true, 
    "inviteRedirectUrl": "https://myapps.microsoft.com" 
}'
https://graph.microsoft.com/v1.0/invitations

Postman Collection Item JSON

{
  "name": "Invite a guest user",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "try {\r",
          "    if (responseBody.indexOf(\"InvalidAuthenticationToken\") !== -1)\r",
          "    {\r",
          "        console.log(\"You need to run *On behalf of a User | Get User Access Token* request first.\");\r",
          "    }\r",
          "    else\r",
          "    {\r",
          "        if (pm.response.status === \"Forbidden\")\r",
          "        {\r",
          "            console.log(\"You need to add user delegated permissions in your application to at least *User.Invite.All* in portal.azure.com and then consent as user or Grant admin consent in portal. And re-run *On behalf of a User | Get User Access Token* request to update access token. \");\r",
          "        }\r",
          "        else\r",
          "        {\r",
          "            var json = JSON.parse(responseBody);\r",
          "            // Get invited user id\r",
          "            postman.setEnvironmentVariable(\"UserId\", json.invitedUser.id);\r",
          "        }\r",
          "    }\r",
          "}\r",
          "catch (e) {\r",
          "    console.log(e);\r",
          "}\r",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{ \r\n    \"invitedUserDisplayName\": \"<Display Name of Invited User>\", \r\n    \"invitedUserEmailAddress\": \"<Email Address of Invited User>\", \r\n    \"invitedUserMessageInfo\": {\r\n        \"messageLanguage\": \"en-US\",\r\n        \"ccRecipients\": [\r\n             {\r\n                \"emailAddress\": {\r\n                    \"name\": \"<Optional CC for Invitation>\",\r\n                    \"address\": \"<Optional CC Email Address for Invitation>\"\r\n                 }\r\n             }\r\n        ],\r\n        \"customizedMessageBody\": \"Hi, you have just been invited to Azure AD with Postman using Microsoft Graph!\"\r\n     },\r\n    \"sendInvitationMessage\": true, \r\n    \"inviteRedirectUrl\": \"https://myapps.microsoft.com\" \r\n} ",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://graph.microsoft.com/v1.0/invitations",
      "protocol": "https",
      "host": [
        "graph",
        "microsoft",
        "com"
      ],
      "path": [
        "v1.0",
        "invitations"
      ]
    },
    "description": "Invite Azure AD B2B Guest User using Delegated Permission"
  },
  "response": [
  ]
}