Microsoft Entra B2B-samarbets-API och anpassning

  • Artikel

Med Microsoft Graph REST API kan du anpassa inbjudningsprocessen på ett sätt som fungerar bäst för din organisation.

Funktioner i inbjudnings-API:et

API:et erbjuder följande funktioner:

  1. Bjud in en extern användare med valfri e-postadress.

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

  2. Anpassa var du vill att användarna ska landa när de har accepterat inbjudan.

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

  3. Välj att skicka standardinbjudan via oss.

    "sendInvitationMessage": true

    med ett meddelande till mottagaren som du kan anpassa.

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

  4. Och välj att cc: personer som du vill behålla i loopen om att du bjuder in den här medarbetaren.

  5. Eller helt anpassa arbetsflödet för inbjudan och registrering genom att välja att inte skicka meddelanden via Microsoft Entra-ID.

    "sendInvitationMessage": false

    I det här fallet får du tillbaka en inlösnings-URL från API:et som du kan bädda in i en e-postmall, snabbmeddelande eller annan distributionsmetod som du väljer.

  6. Om du är administratör kan du slutligen välja att bjuda in användaren som medlem.

    "invitedUserType": "Member"

Kontrollera om en användare redan har bjudits in till din katalog

Du kan använda api:et för inbjudan för att avgöra om en användare redan finns i resursklientorganisationen. Detta kan vara användbart när du utvecklar en app som använder inbjudnings-API:et för att bjuda in en användare. Om användaren redan finns i resurskatalogen får de ingen inbjudan, så du kan köra en fråga först för att avgöra om e-postmeddelandet redan finns som ett UPN eller någon annan inloggningsegenskap.

  1. Kontrollera att användarens e-postdomän inte ingår i resursklientens verifierade domän.

  2. I resursklientorganisationen använder du följande hämta användarfråga där {0} är den e-postadress som du bjuder in:

    “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}')"

Auktoriseringsmodell

API:et kan köras i följande auktoriseringslägen:

App - och användarläge

I det här läget måste den som använder API:et ha behörighet att skapa B2B-inbjudningar.

Endast appläge

I appens enda kontext behöver appen User.Invite.All omfång för att inbjudan ska lyckas.

För ytterligare information, se: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShell

Du kan använda PowerShell för att enkelt lägga till och bjuda in externa användare till en organisation. Skapa en inbjudan med hjälp av cmdleten:

New-MgInvitation

Du kan använda följande alternativ:

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

Inbjudans status

När du har skickat en inbjudan till en extern användare kan du använda cmdleten Get-MgBetaUser för att se om de har accepterat den. Följande egenskaper för Get-MgBetaUser fylls i när en extern användare skickas en inbjudan:

  • externalUserState anger om inbjudan är PendingAcceptance eller Godkänd.
  • externalUserStateChangeDateTime visar tidsstämpeln för den senaste ändringen av egenskapen externalUserState .

Du kan använda alternativet Filter för att filtrera resultatet efter externalUserState. Exemplet nedan visar hur du filtrerar resultat så att endast användare som har en väntande inbjudan visas. Exemplet visar också alternativet Format-List , där du kan ange vilka egenskaper som ska visas.

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

Kommentar

Kontrollera att du har den senaste versionen av Microsoft Graph PowerShell-modulen

Se även

Kolla in API-referensen för inbjudan i https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation.

Nästa steg