Azure Active Directory B2B işbirliği API ve özelleştirmeAzure Active Directory B2B collaboration API and customization

Biz, birçok müşteri, kuruluşları için en iyi şekilde davet sürecini özelleştirmek istedikleri bize vardı.We've had many customers tell us that they want to customize the invitation process in a way that works best for their organizations. API ile bunu yapabilirsiniz.With our API, you can do just that. https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation

Davet API özellikleriCapabilities of the invitation API

API, aşağıdaki özellikleri sunar:The API offers the following capabilities:

  1. İle bir dış kullanıcıyı davet herhangi e-posta adresi.Invite an external user with any email address.

    "invitedUserDisplayName": "Sam"
    "invitedUserEmailAddress": "gsamoogle@gmail.com"
    
  2. Bunlar, davetini kabul ettikten sonra kavuşmak kullanıcılarınıza istediğiniz özelleştirin.Customize where you want your users to land after they accept their invitation.

    "inviteRedirectUrl": "https://myapps.microsoft.com/"
    
  3. Standart bir davet e-posta yoluyla bize gönderebilirsinizChoose to send the standard invitation mail through us

    "sendInvitationMessage": true
    

    özelleştirebileceğiniz alıcı ile bir iletiwith a message to the recipient that you can customize

    "customizedMessageBody": "Hello Sam, let's collaborate!"
    
  4. Kime seçin: kişiler bu ortak çalışanı davet hakkında döngüsünde tutmak istediğinizi.And choose to cc: people you want to keep in the loop about your inviting this collaborator.

  5. Veya Azure AD üzerinden bildirim göndermek seçerek daveti ve ekleme iş akışı tamamen özelleştirebilirsiniz.Or completely customize your invitation and onboarding workflow by choosing not to send notifications through Azure AD.

    "sendInvitationMessage": false
    

    Bu durumda, bir kullanım URL, bir e-posta şablonu, anlık ileti veya diğer dağıtım yöntemini seçeceğiniz katıştırabilirsiniz API'sinden ulaşırsınız.In this case, you get back a redemption URL from the API that you can embed in an email template, IM, or other distribution method of your choice.

  6. Son olarak, bir yönetici, üye olarak kullanıcı davet seçebilirsiniz.Finally, if you are an admin, you can choose to invite the user as member.

    "invitedUserType": "Member"
    

Yetkilendirme modeliAuthorization model

API aşağıdaki yetkilendirme modu çalıştırabilirsiniz:The API can be run in the following authorization modes:

Uygulama + kullanıcı moduApp + User mode

Bu modda, kişi B2B davetleri olması oluşturma izinlerine sahip API gereksinimlerini kullanıyor.In this mode, whoever is using the API needs to have the permissions to be create B2B invitations.

Tek uygulama moduApp only mode

Uygulama yalnızca bağlamında, uygulamanın, başarılı olması davet User.Invite.All kapsamını gerekir.In app only context, the app needs the User.Invite.All scope for the invitation to succeed.

Daha fazla bilgi için bkz: https://developer.microsoft.com/graph/docs/authorization/permission_scopesFor more information, refer to: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShellPowerShell

Ekleme ve bir kuruluşun dış kullanıcılara bir kolayca davet için PowerShell kullanabilirsiniz.You can use PowerShell to add and invite external users to an organization easily. Cmdlet'ini kullanarak bir davet oluşturun:Create an invitation using the cmdlet:

New-AzureADMSInvitation

Aşağıdaki seçenekleri kullanabilirsiniz:You can use the following options:

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

Davet durumuInvitation status

Bir dış kullanıcıyı Davet Gönder sonra kullanabileceğiniz Get-AzureADUser bunlar kabul, görmek için cmdlet.After you send an external user an invitation, you can use the Get-AzureADUser cmdlet to see if they've accepted it. Get-AzureADUser aşağıdaki özelliklerini bir dış kullanıcıyı davet gönderildiğinde doldurulur:The following properties of Get-AzureADUser are populated when an external user is sent an invitation:

  • UserState davet olup olmadığını belirten PendingAcceptance veya kabul edilen.UserState indicates whether the invitation is PendingAcceptance or Accepted.
  • UserStateChangedOn yapılan son değişikliği için zaman damgasını gösterir UserState özelliği.UserStateChangedOn shows the timestamp for the latest change to the UserState property.

Kullanabileceğiniz filtre sonuçlarına göre filtreleme seçeneğini UserState.You can use the Filter option to filter the results by UserState. Aşağıdaki örnek, bekleyen davet sahip kullanıcıları göstermek için sonuçları filtrelemek gösterilmektedir.The example below shows how to filter results to show only users who have a pending invitation. Örnek ayrıca gösterir Format-List seçeneği, görüntülenecek özelliklerini belirtmenize olanak tanır.The example also shows the Format-List option, which lets you specify the properties to display.

Get-AzureADUser -Filter "UserState eq 'PendingAcceptance'" | Format-List -Property DisplayName,UserPrincipalName,UserState,UserStateChangedOn

Not

AzureAD PowerShell modülü veya AzureADPreview PowerShell modülünün en son sürümü olduğundan emin olun.Make sure you have the latest version of the AzureAD PowerShell module or AzureADPreview PowerShell module.

Ayrıca bkz.See also

Davet API başvurusunda kullanıma https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation .Check out the invitation API reference in https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation.

Sonraki adımlarNext steps