Azure Active Directory B2B işbirliği API'si ve özelleştirme

Birçok müşteri, davet işlemini kuruluşları için en iyi şekilde özelleştirmek istiyor. API'miz ile tam olarak bunu yapabiliriz. https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation

Davet API'sini özellikleri

API aşağıdaki özellikleri sunar:

  1. Herhangi bir e-posta adresine sahip bir dış kullanıcı davet edin.

    "invitedUserDisplayName": "Sam"
    "invitedUserEmailAddress": "gsamoogle@gmail.com"
    
  2. Kullanıcılarının davetlerini kabul etmelerinden sonra nereye inerlerini istediğiniz yeri özelleştirin.

    "inviteRedirectUrl": "https://myapps.microsoft.com/"
    
  3. Standart davet e-postalarını bizimle göndermeyi seçin

    "sendInvitationMessage": true
    

    alıcının özelleştirebileceğiniz bir iletiyle

    "customizedMessageBody": "Hello Sam, let's collaborate!"
    
  4. Ayrıca bilgi: Bu ortak çalışanını davet etme döngüsünde tutmak istediğiniz kişiler.

  5. Veya Azure AD aracılığıyla bildirim göndermeyerek davet ve ekleme iş akışınızı tamamen özelleştirebilirsiniz.

    "sendInvitationMessage": false
    

    Bu durumda, API'den bir e-posta şablonuna, IM'ye veya istediğiniz başka bir dağıtım yöntemine katıştırmak için bir geri ödeme URL'si alırsınız.

  6. Son olarak, yöneticiyseniz, kullanıcıyı üye olarak davet etmek seçebilirsiniz.

    "invitedUserType": "Member"
    

Bir kullanıcının dizininize zaten davet edildi olup olmadığını belirleme

Bir kullanıcının kaynak kiracınız içinde zaten mevcut olup olmadığını belirlemek için davet API'sini kullanabilirsiniz. Bu, bir kullanıcı davet etmek için davet API'sini kullanan bir uygulama geliştiriyorsanız yararlı olabilir. Kullanıcı kaynak dizinde zaten varsa davet almaz. Bu nedenle, zaten e-postanın UPN veya başka bir oturum açma özelliği olarak mevcut olup olmadığını belirlemek için önce bir sorgu çalıştırabilirsiniz.

  1. Kullanıcının e-posta etki alanının kaynak kiracınız tarafından doğrulanmış etki alanının parçası olduğundan emin olun.

  2. Kaynak kiracıda aşağıdaki kullanıcı al sorgusunu kullanın; {0} burada davet ettiğiniz e-posta adresidir:

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

Yetkilendirme modeli

API aşağıdaki yetkilendirme modlarında çalışır:

Uygulama + Kullanıcı modu

Bu modda, API'yi kullanan kişinin B2B davetleri oluşturma izinlerine sahip olması gerekir.

Yalnızca uygulama modu

Yalnızca uygulama bağlamında, uygulamanın davetin başarılı olması için User.Invite.All kapsamına ihtiyacı vardır.

Daha fazla bilgi için bkz: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShell

Bir kuruluşa dış kullanıcıları kolayca eklemek ve davet etmek için PowerShell'i kullanabilirsiniz. cmdlet'ini kullanarak bir davet oluşturun:

New-AzureADMSInvitation

Aşağıdaki seçenekleri kullanabilirsiniz:

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

Davet durumu

Bir dış kullanıcıya davet gönderdikten sonra, kabul edilp edilmediğini görmek için Get-AzureADUser cmdlet'ini kullanabilirsiniz. Dış kullanıcıya davet Get-AzureADUser aşağıdaki özellikleri doldurulur:

  • UserState, davetin PendingAcceptance veya Acceptedolduğunu gösterir.
  • UserStateChangedOn, UserState özelliğine yapılan en son değişikliğin zaman damgasını gösterir.

Sonuçları UserState'e göre filtrelemek için Filtre seçeneğini kullanabilirsiniz. Aşağıdaki örnekte, sonuçları yalnızca bekleyen daveti olan kullanıcıları gösterecek şekilde filtreleme gösterilmiştir. Örnekte ayrıca görüntü özelliklerini belirtmenize olanak sağlayan Biçim-Listesi seçeneği de gösterilir.

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

Not

AzureAD PowerShell modülünün veya AzureADPreview PowerShell modülünün en son sürümüne sahip olduğundan emin olun.

Ayrıca bkz.

içinde davet API'si başvurusuna göz https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitation atabilirsiniz.

Sonraki adımlar