Sdílet prostřednictvím

Rozhraní API a přizpůsobení spolupráce Microsoft Entra B2B

  • Článek

Platí pro: Zelený kruh s bílým symbolem zaškrtnutí Tenanti pracovních sil – externí tenanti Bílý kruh se šedým symbolem X. (další informace)

Pomocí rozhraní Microsoft Graph REST API můžete proces pozvání přizpůsobit způsobem, který bude pro vaši organizaci nejvhodnější.

Možnosti rozhraní API pro pozvánky

Rozhraní API nabízí následující možnosti:

  1. Pozvěte externího uživatele s libovolnou e-mailovou adresou.

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

  2. Přizpůsobte si, kde chcete, aby vaši uživatelé přistáli po přijetí pozvánky.

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

  3. Zvolte, že nám pošlete standardní e-mail s pozvánkou.

    "sendInvitationMessage": true

    se zprávou příjemce, který si můžete přizpůsobit.

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

  4. A zvolte si kopie: lidé, které chcete mít ve smyčce o pozvání tohoto spolupracovníka.

  5. Nebo úplně přizpůsobte svůj pracovní postup pozvání a onboardingu tím, že se rozhodnete neodesílat oznámení prostřednictvím ID Microsoft Entra.

    "sendInvitationMessage": false

    V takovém případě získáte zpět adresu URL uplatnění z rozhraní API, které můžete vložit do e-mailové šablony, rychlé zprávy nebo jiné metody distribuce podle vašeho výběru.

  6. A konečně, pokud jste správce, můžete uživatele pozvat jako člena.

    "invitedUserType": "Member"

Určení, jestli už byl uživatel pozván do vašeho adresáře

Pomocí rozhraní API pro pozvání můžete určit, jestli už uživatel ve vašem tenantovi prostředků existuje. To může být užitečné při vývoji aplikace, která k pozvání uživatele používá rozhraní API pozvánky. Pokud už uživatel ve vašem adresáři prostředků existuje, nedostane pozvánku, takže nejdřív můžete spustit dotaz, abyste zjistili, jestli e-mail už existuje jako hlavní název uživatele (UPN) nebo jiná přihlašovací vlastnost.

  1. Ujistěte se, že doména e-mailu uživatele není součástí ověřené domény tenanta vašeho prostředku.

  2. V tenantovi prostředků použijte následující dotaz uživatele, kde je e-mailová adresa, kterou {0} zvete:

    “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 autorizace

Rozhraní API je možné spustit v následujících režimech autorizace:

Režim aplikace a uživatele

V tomto režimu musí mít kdokoli, kdo používá rozhraní API, oprávnění k vytváření pozvánek B2B.

Režim pouze aplikace

V kontextu aplikace potřebuje obor User.Invite.All, aby pozvánka byla úspěšná.

Další informace najdete tady: https://developer.microsoft.com/graph/docs/authorization/permission_scopes.

PowerShell

PowerShell můžete použít k snadnému přidání a pozvání externích uživatelů do organizace. Vytvořte pozvánku pomocí rutiny:

New-MgInvitation

Můžete použít následující možnosti:

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

Stav pozvánky

Po odeslání pozvánky externím uživatelem můžete pomocí rutiny Get-MgBetaUser zjistit, jestli ji přijal. Následující vlastnosti Get-MgBetaUser se vyplní při odeslání pozvánky externím uživatelem:

  • externalUserState označuje, jestli je pozvánka PendingAcceptance nebo Akceptovaná.
  • externalUserStateChangeDateTime zobrazuje časové razítko poslední změny vlastnosti externalUserState .

Pomocí možnosti Filtr můžete filtrovat výsledky podle externalUserState. Následující příklad ukazuje, jak filtrovat výsledky tak, aby zobrazovaly jenom uživatele, kteří mají čekající pozvánku. Příklad také ukazuje možnost Formát-Seznam , která umožňuje zadat vlastnosti, které se mají zobrazit.

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

Poznámka:

Ujistěte se, že máte nejnovější verzi modulu Microsoft Graph PowerShell.

Viz také

Podívejte se na referenční informace k rozhraní API pozvánky v https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitationsouboru .

Další kroky