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

Davet işlemini özelleştirmek isteyen birçok müşterimiz oldu. API'mizle davet sürecini kuruluşunuz için en uygun şekilde özelleştirebilirsiniz.

Davet API'sinin özellikleri

API aşağıdaki özellikleri sunar:

  1. Herhangi bir e-posta adresi olan bir dış kullanıcıyı davet edin.

    "invitedUserDisplayName": "Taylor"
    "invitedUserEmailAddress": "taylor@fabrikam.com"
    
  2. Kullanıcılarınızın davetlerini kabul ettikten sonra nereye inmesini istediğinizi özelleştirin.

    "inviteRedirectUrl": "https://myapps.microsoft.com/"
    
  3. Standart davet e-postasını bizim tarafımızdan göndermeyi seçin.

    "sendInvitationMessage": true
    

    öğesini seçin.

    "customizedMessageBody": "Hello Sam, let's collaborate!"
    
  4. Ve bilgi almayı seçin: Bu ortak çalışanı davet etmenizle ilgili olarak döngüde tutmak istediğiniz kişiler.

  5. Veya Azure AD aracılığıyla bildirim göndermeme seçeneğini belirleyerek davetinizi ve ekleme iş akışınızı tamamen özelleştirebilirsiniz.

    "sendInvitationMessage": false
    

    Bu durumda API'den e-posta şablonuna, anlık iletiye veya seçtiğiniz başka bir dağıtım yöntemine ekleyebileceğiniz bir kullanım URL'sini geri alırsınız.

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

    "invitedUserType": "Member"
    

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

Kaynak kiracınızda bir kullanıcının zaten var olup olmadığını belirlemek için davet API'sini kullanabilirsiniz. Bu, kullanıcıyı davet etmek için davet API'sini kullanan bir uygulama geliştirirken yararlı olabilir. Kullanıcı kaynak dizininizde zaten varsa davet almaz, bu nedenle e-postanın zaten 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ın doğrulanmış etki alanının bir parçası olmadığından emin olun.

  2. Kaynak kiracısında, davet ettiğiniz e-posta adresi olan {0} aşağıdaki get user sorgusunu kullanın:

    “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ıştırılabilir:

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, davetin başarılı olması için uygulamanın User.Invite.All kapsamına ihtiyacı vardır.

Daha fazla bilgi için, şuraya bakın: https://developer.microsoft.com/graph/docs/authorization/permission_scopes

PowerShell

PowerShell'i kullanarak kuruluşa kolayca dış kullanıcılar ekleyebilir ve davet edebilirsiniz. cmdlet'ini kullanarak davet oluşturun:

New-AzureADMSInvitation

Aşağıdaki seçenekleri kullanabilirsiniz:

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

Davet durumu

Dış kullanıcıya davet gönderdikten sonra Get-AzureADUser cmdlet'ini kullanarak kabullenip kabul etmediklerini görebilirsiniz. Dış kullanıcıya davet gönderildiğinde aşağıdaki Get-AzureADUser özellikleri doldurulur:

  • UserState , davetin PendingAcceptance mı yoksa Accepted mi olduğunu gösterir.
  • UserStateChangedOn , UserState özelliğinde 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ın yalnızca bekleyen daveti olan kullanıcıları gösterecek şekilde nasıl filtreleneceği gösterilmektedir. Örnekte, görüntülenecek özellikleri belirtmenize olanak tanıyan 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ğunuzdan emin olun.

Ayrıca bkz.

içinde davet API'sinin başvurusuna https://developer.microsoft.com/graph/docs/api-reference/v1.0/resources/invitationgöz atın.

Sonraki adımlar