Microsoft Entra B2B együttműködési API és testreszabás

  • Cikk

A Microsoft Graph REST API-val úgy szabhatja testre a meghívási folyamatot, hogy az a szervezet számára a legjobban működjön.

A meghívási API képességei

Az API a következő képességeket kínálja:

  1. Külső felhasználó meghívása bármilyen e-mail-címmel.

    "invitedUserDisplayName": "Taylor"
"invitedUserEmailAddress": "taylor@fabrikam.com"

  2. Testre szabhatja, hogy a felhasználók hol szálljanak le a meghívás elfogadása után.

    "inviteRedirectUrl": "https://myapps.microsoft.com/"

  3. Válassza ki, hogy a szokásos meghívó e-mailt küldje el nekünk.

    "sendInvitationMessage": true

    a testre szabható címzettnek szóló üzenettel.

    "customizedMessageBody": "Hello Sam, let's collaborate!"

  4. És válassza a cc: azokat a személyeket, akiket meg szeretne tartani a meghívott közreműködőről.

  5. Vagy teljesen testre szabhatja a meghívást és az előkészítési munkafolyamatot, ha úgy dönt, hogy nem küld értesítéseket a Microsoft Entra-azonosítón keresztül.

    "sendInvitationMessage": false

    Ebben az esetben egy beváltási URL-címet kap vissza az API-ból, amelyet beágyazhat egy e-mail-sablonba, csevegésbe vagy más tetszőleges terjesztési módszerbe.

  6. Végül, ha Ön rendszergazda, választhatja, hogy meghívja a felhasználót tagként.

    "invitedUserType": "Member"

Annak megállapítása, hogy egy felhasználót már meghívtak-e a címtárba

A meghívó API-val megállapíthatja, hogy egy felhasználó már létezik-e az erőforrás-bérlőben. Ez akkor lehet hasznos, ha olyan alkalmazást fejleszt, amely a meghívó API-t használja egy felhasználó meghívására. Ha a felhasználó már létezik az erőforráskönyvtárban, nem kap meghívót, így először lefuttathat egy lekérdezést annak megállapításához, hogy az e-mail már létezik-e UPN-ként vagy más bejelentkezési tulajdonságként.

  1. Győződjön meg arról, hogy a felhasználó levelezési tartománya nem része az erőforrás-bérlő ellenőrzött tartományának.

  2. Az erőforrás-bérlőben használja a következő lekéréses felhasználói lekérdezést, ahol {0} a meghívni kívánt e-mail-cím található:

    “userPrincipalName eq '{0}' or mail eq '{0}' or proxyAddresses/any(x:x eq 'SMTP:{0}') or signInNames/any(x:x eq '{0}') or otherMails/any(x:x eq '{0}')"

Engedélyezési modell

Az API a következő engedélyezési módokon futtatható:

Alkalmazás+ felhasználói mód

Ebben a módban bárki is használja az API-t, rendelkeznie kell a B2B-meghívók létrehozásához szükséges engedélyekkel.

Csak alkalmazás mód

Csak alkalmazáskörnyezetben az alkalmazásnak a User.Invite.All hatókörre van szüksége ahhoz, hogy a meghívás sikeres legyen.

További információ: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShell

A PowerShell használatával egyszerűen vehet fel és hívhat meg külső felhasználókat egy szervezethez. Hozzon létre egy meghívót a parancsmaggal:

New-MgInvitation

A következő lehetőségeket használhatja:

  • -InvitedUserDisplayName
  • -InvitedUserEmailAddress
  • -SendInvitationMessage
  • -InvitedUserMessageInfo

Meghívás állapota

Miután meghívót küldött egy külső felhasználónak, a Get-MgBetaUser parancsmaggal ellenőrizheti, hogy elfogadták-e. A Get-MgBetaUser következő tulajdonságai lesznek feltöltve, amikor egy külső felhasználó meghívót kap:

  • az externalUserState azt jelzi, hogy a meghívás PendingAcceptance vagy Accepted.
  • az externalUserStateChangeDateTime az externalUserState tulajdonság legutóbbi módosításának időbélyegét jeleníti meg.

A Szűrés beállítással szűrheti az eredményeket az externalUserState alapján. Az alábbi példa bemutatja, hogyan szűrheti az eredményeket, hogy csak a függőben lévő meghívóval rendelkező felhasználók jelenjenek meg. A példában a Formátum-lista lehetőség is látható, amellyel megadhatja a megjelenítendő tulajdonságokat.

Get-MgBetaUser -Filter "externalUserState eq 'PendingAcceptance'" | Format-List -Property DisplayName,UserPrincipalName,externalUserState,externalUserStateChangeDateTime

Feljegyzés

Győződjön meg arról, hogy a Microsoft Graph PowerShell modul legújabb verziójával rendelkezik

Lásd még

Tekintse meg a meghívó API-referenciát a következő helyen https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation: .

Következő lépések