Microsoft Entra B2B collaboration API i dostosowywanie

Dotyczy:Dzierżawcy siły roboczej — dzierżawcy zewnętrzni (dowiedz się więcej)

Za pomocą interfejsu API REST programu Microsoft Graph możesz dostosować proces zapraszania w sposób, który najlepiej sprawdza się w twojej organizacji.

Możliwości interfejsu API zaproszeń

Interfejs API oferuje następujące możliwości:

1. Poniższa reprezentacja JSON pokazuje, jak zaprosić użytkownika zewnętrznego dowolny adres e-mail.

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

2. Dostosuj miejsce, w którym użytkownicy mają wylądować po zaakceptowaniu zaproszenia.

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

3. Wybierz wysłanie standardowej wiadomości e-mail z zaproszeniem za pośrednictwem nas.

   "sendInvitationMessage": true
   

   Za pomocą wiadomości do adresata, którą można dostosować.

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

4. Wybierz dw: osoby, które chcesz zachować w pętli na temat zapraszania tego współpracownika.

5. Możesz też całkowicie dostosować swój przepływ pracy zapraszania i dołączania, nie wysyłając powiadomień za pośrednictwem identyfikatora Entra firmy Microsoft.

   "sendInvitationMessage": false
   

   W takim przypadku otrzymasz adres URL realizacji z interfejsu API, który można osadzić w szablonie wiadomości e-mail, wiadomościach błyskawicznych lub innej wybranej metodzie dystrybucji.

6. Jeśli jesteś administratorem, możesz zaprosić użytkownika jako członka.

   "invitedUserType": "Member"
   

Ustal, czy użytkownik został już zaproszony do katalogu

Interfejs API zaproszeń umożliwia określenie, czy użytkownik już istnieje w dzierżawie zasobów. Może to być przydatne podczas tworzenia aplikacji korzystającej z interfejsu API zaproszenia do zapraszania użytkownika. Jeśli użytkownik już istnieje w katalogu zasobów, nie otrzyma zaproszenia, aby najpierw uruchomić zapytanie, aby określić, czy wiadomość e-mail już istnieje jako nazwa UPN, czy inna właściwość logowania.

1. Upewnij się, że domena poczty e-mail użytkownika nie jest częścią domeny zweryfikowanej przez dzierżawę zasobów.

2. W dzierżawie zasobów użyj następującego zapytania get user, gdzie 0 to adres e-mail, który zapraszasz:

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

Model autoryzacji

Interfejs API można uruchomić w następujących trybach autoryzacji:

Tryb aplikacji i użytkownika

W tym trybie, kto używa interfejsu API, musi mieć uprawnienia do tworzenia zaproszeń B2B.

Tryb tylko aplikacji

W kontekście aplikacji aplikacja wymaga zakresu User.Invite.All, aby zaproszenie powiodło się.

Aby uzyskać więcej informacji, zobacz: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShell

Program PowerShell umożliwia łatwe dodawanie i zapraszanie użytkowników zewnętrznych do organizacji. Utwórz zaproszenie przy użyciu polecenia cmdlet :

New-MgInvitation

Możesz użyć następujących opcji:

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

Stan zaproszenia

Po wysłaniu użytkownika zewnętrznego zaproszeń możesz użyć polecenia cmdlet Get-MgBetaUser , aby sprawdzić, czy je zaakceptowali. Następujące właściwości polecenia Get-MgBetaUser są wypełniane po wysłaniu zaproszenia przez użytkownika zewnętrznego:

• externalUserState wskazuje, czy zaproszenie ma wartość PendingAcceptance , czy Zaakceptowano.
• externalUserStateChangeDateTime pokazuje znacznik czasu dla najnowszej zmiany właściwości externalUserState .

Możesz użyć opcji Filtr , aby filtrować wyniki według externalUserState. W poniższym przykładzie pokazano, jak filtrować wyniki, aby wyświetlić tylko użytkowników, którzy mają oczekujące zaproszenie. W przykładzie przedstawiono również opcję Format-Lista , która umożliwia określenie właściwości do wyświetlenia.

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

Uwaga

Upewnij się, że masz najnowszą wersję modułu Microsoft Graph PowerShell

Zobacz też

Zapoznaj się z dokumentacją interfejsu API zaproszeń w pliku https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation.

Powiązana zawartość

• Co to jest współpraca firmy Microsoft Entra B2B?
• Dodawanie i zapraszanie użytkowników-gości
• Elementy wiadomości e-mail z zaproszeniem do współpracy B2B