Synchronisation des utilisateurs avec Azure AD/Active Directory

Le module BrightBookingUserAdminTools a les dépendances suivantes :

• PowerShell version 5 ou supérieure
• Les modules PowerShell suivants :
  • Galerie PowerShell
  • ActiveDirectory
  • Azure AD
• La machine (serveur) doit être liée à votre domaine Windows.

Veuillez suivre les étapes suivantes pour installer les dépendances :

1. Connectez-vous à la machine (serveur) sur laquelle vous voulez installer la tâche. (cette machine doit être liée au domaine Windows).
2. Lancez PowerShell sur cette machine, en tant qu'"administrateur" :
   
3. Vérifiez si PowerShell 5 est installé :
   • Exécutez la commande suivante :
     

     $PSVersionTable.PSVersion

   • Dans le résultat que vous obtenez, le "Major" doit être égal ou supérieur à "5".
   • Si le 'Majorest inférieur à5', suivez les étapes suivantes :
     • Installer Windows Management Framework 5 (cela inclut PowerShell 5) :
       Télécharger Windows Management Framework 5
     • Note 1 : si vous obtenez l'erreur "La mise à jour n'est pas applicable à votre ordinateur", vous avez probablement sélectionné le mauvais téléchargement, veuillez vous référer à cet article.
     • Note 2 : Windows Management Framework 5 dépend de .NET Framework 4.5.
     • Note 3 : Un redémarrage est probablement nécessaire.
     • Après l'installation, veuillez vérifier si le 'Majorest5ou plus :
       

       $PSVersionTable.PSVersion

4. Installez le module PowerShellGallery PowerShell :
   • Exécutez les commandes suivantes dans PowerShell (en tant qu'administrateur)
   • Installez le NuGet PackageProvider :
     

     Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force

   • Configurez PowerShellGallery comme une source de confiance :
     

     Set-PSRepository -Name PSGallery -InstallationPolicy Trusted

   • Installez le module PowerShellGet :
     

     Import-Module -Name PowerShellGet

5. Si vous voulez vous synchroniser avec Active Directory: Installer le module ActiveDirectory PowerShell :
   • Le module ActiveDirectory PowerShell fait partie des outils d'administration de serveur à distance (RSAT).
   • Veuillez suivre les étapes suivantes pour installer les Outils d'administration du serveur à distance (RSAT)
6. Si vous voulez vous synchroniser avec Azure AD: Installez le module Azure AD PowerShell :
   • Exécutez les commandes suivantes dans PowerShell (en tant qu'administrateur)
   • Installez le module Azure AD :
     

     Install-Module -Name AzureAD

Installez ou mettez à jour le module PowerShell BrightBookingUserAdminTools :

Install-Module -Name BrightBookingUserAdminTools -Force

La commande '-Force' permet de s'assurer que la dernière version du module est installée même si une installation antérieure existe. Si le module était déjà installé, la session PowerShell devra être redémarrée.

Pour pouvoir synchroniser les utilisateurs, vous devez obtenir les informations suivantes dans le portail GoBright :

• L'URL de l'API et la clé de l'API
• Le nom de l'intégration qui doit être liée aux utilisateurs.

Suivez ces étapes pour trouver l'URL de l'API et la clé de l'API :

• Connectez-vous avec un compte de gestionnaire sur le portail GoBright .
• Allez dans le centre d'administration > Intégrations > Accès API
• Générez une clé API en cliquant sur le bouton "Ajouter". Choisissez le type "manager" et entrez une description pour une référence ultérieure.
  • Remarque : veillez à sauvegarder la clé API, car il n'y a aucun moyen de la récupérer.
• L'URL de l'API est l'URL de votre environnement GoBright qui se trouve dans la barre d'URL de votre navigateur et sous Centre d'administration > Intégrations > Accès API: API url https://[tenant-id].gobright.cloud/

Suivez ces étapes pour trouver le nom de l'intégration :

• Connectez-vous avec un compte de gestionnaire sur le portail GoBright .
• Allez dans le centre d'administration > Intégrations
• Copiez le nom de l'intégration (Exchange/Office 365) qui doit être utilisée pour relier les utilisateurs à la base de données.

Le nom de l'intégration, l'URL de l'API et la clé de l'API sont nécessaires dans les étapes suivantes.

Dans la dernière étape, vous construirez le script réel pour indiquer au module PowerShell GoBright les utilisateurs que vous souhaitez obtenir et pousser vers votre environnement GoBright . Ceci peut être fait avec Azure AD ou Active Directory.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 
$ErrorActionPreference = "Stop"

Choisissez ci-dessous l'une des explications du scénario qui s'applique à votre situation.

Étape 4.1 : Se connecter à Azure AD

Lancez PowerShell et connectez-vous à Azure AD via la commande standard "Connect-AzureAD".

Étape 4.2 : tester la sélection des utilisateurs

La commande pour obtenir les informations d'Active Directory et les traiter dans BrightBooking est la suivante :

Get-AzureADUser -All $true [optional: filter] | Push-AzureADUsersToBB [optional: specific username/pincode field] -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]'

Vous pouvez utiliser les paramètres suivants dans la commande 'Push-AzureADUsersToBB' :

Vous trouverez ci-dessous plusieurs exemples de commandes. Vous pouvez les adapter à votre situation.

Ces commandes ne mettront pas encore à jour les utilisateurs dans le système. Il s'agit donc de commandes de test, car elles incluent le paramètre '-WhatIf'.

Exemples de commandes de test :

Traiter tous les utilisateurs dans Azure AD à GoBright:

Get-AzureADUser -All $true | Push-AzureADUsersToBB -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter les utilisateurs dont le NUP se termine par 'yourdomain.com' vers GoBright:

Get-AzureADUser -All $true | where {$_.userprincipalname -like "*yourdomain.com"} | Push-AzureADUsersToBB -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traitez les utilisateurs avec un identifiant NFC et un code pin dans un attribut personnalisé, notez que le nom de l' attribut d'extension doit être identique à celui dans Azure AD :

$users_all_import = Get-AzureADUser -All $true [optional: filter]
 $users_all = @()


 $pincodeField = '[Extension attribute here]'


 $NFCField = '[Extension attribute here]'


 Foreach ($user in $users_all_import) {

 $getExtensionProperty = $user | Select-Object -ExpandProperty ExtensionProperty

 If ($getExtensionProperty.$pincodeField) {

 $pin = (Get-AzureADUserExtension -ObjectId $user.ObjectId).get_item($pincodeField)

 } Else {

 $pin = ''

 }


 If ($getExtensionProperty.$NFCField) {

 $nfc = (Get-AzureADUserExtension -ObjectId $user.ObjectId).get_item($NFCField)

 } Else {

 $nfc = ''

 }


 $user | Add-Member UserPincode $pin -Force

 $user | Add-Member UserNFC $nfc -Force

 $users_all += $user

 }


 $users_all | Push-AzureADUsersToBB -ADUserPincodePropertyName UserPincode -ADUserNFCIdPropertyName UserNFC -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traitez les utilisateurs et ajoutez les rôles d'utilisateur dans GoBright en fonction de leur appartenance à un groupe dans Azure AD :

$groupToRoleMapping = @()
 $groupToRoleMapping += @ # match specific users that belong to a group for Meet-Work-Visit
 $groupToRoleMapping += @ # match specific users that belong to a group for Meet-Work-Visit
 $groupToRoleMapping += @ # match specific users that belong to a group for Meet-Work-Visit
 $groupToRoleMapping += @ # match specific users that belong to a group for View

 $groupToRoleMapping += @ # **special case** this line matches for every user, because of the 'MatchType', and is needed when you want to have a generic role for every user

 $roleNameDefaultIfNoGroupMatched = "Regular user"


 $users_all = Get-AzureADUser -All $true
 $users_all | Push-AzureADUsersToBB -UserDefaultRoleName $roleNameDefaultIfNoGroupMatched -GroupUserRoleMapping $groupToRoleMapping -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter tous les utilisateurs sauf ceux qui sont membres d'un groupe spécifique dans Azure AD :

$excludedGroups = @()
 $excludedGroups += '[GroupName1]'
 $excludedGroups += '[GroupName2]'
 $excludedGroups += '[GroupName3]'
 $ADGroups = Get-AzureADGroup -All $true | Where-Object { $excludedGroups -notcontains $_.DisplayName }
 $users_all = $ADGroups | Get-AzureADGroupMember -All $true
 $users_all | Push-AzureADUsersToBB -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Étape 4.2 : Exécuter la synchronisation réelle

Une fois que la liste des utilisateurs est correctement filtrée, vous pouvez exécuter la synchronisation réelle en supprimant le paramètre '-WhatIf'.

Exécutez maintenant la même commande, mais sans '-WhatIf' et elle traitera les utilisateurs dans votre environnement GoBright .

Étape 4.3 : Planifiez l'intégration pour qu'elle s'exécute périodiquement via le planificateur de tâches de Windows.

Pour pouvoir exécuter le script sans surveillance, vous devez vous connecter automatiquement.

Méthode conseillée de connexion sans surveillance :
La méthode conseillée pour effectuer une connexion sans surveillance consiste à créer une application enregistrée dans Azure AD et à se connecter à cette application :

#script for creating user, cert, and get tenantid #getting data for daily script
 Connect-AzureAD $pwd = "Password to encrypt the cert" $subject = "GoBright_unattendedlogin" # may not be longer than 15 characters = the name certificate and app $tmppath = "C:tmp" $certname= "unattendedlogin_azuread.pfx" $fullcertpath = "C:tmpunattendedlogin.pfx" $IdentifierUris = "https://www.fillInYourOwnDomain.com" # Here you need to fill in your own domain name
 $thumb = (New-SelfSignedCertificate -CertStoreLocation Cert:CurrentUserMy -subject $subject -KeyExportPolicy Exportable -NotAfter (Get-Date).AddYears(10) -Type CodeSigningCert -KeySpec Signature).Thumbprint $pwd = ConvertTo-SecureString -String $pwd -Force -AsPlainText if ($tmppath -eq $false) Export-PfxCertificate -cert "cert:CurrentUsermy$thumb" -FilePath $fullcertpath -Password $pwd
 $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate($fullcertpath, $pwd) $keyValue = [System.Convert]::ToBase64String($cert.GetRawCertData())
 $application = New-AzureADApplication -DisplayName $subject -IdentifierUris $IdentifierUris New-AzureADApplicationKeyCredential -ObjectId $application.ObjectId -CustomKeyIdentifier $subject -Type AsymmetricX509Cert -Usage Verify -Value $keyValue $sp=New-AzureADServicePrincipal -AppId $application.AppId Add-AzureADDirectoryRoleMember -ObjectId (Get-AzureADDirectoryRole | where-object {$_.DisplayName -eq "Directory Readers"}).Objectid -RefObjectId $sp.ObjectId
 $tenantid = Get-AzureADTenantDetail | Select ObjectId -ExpandProperty ObjectId $appid = $application.AppId $thumb $tenantid $appid
 #copy data from thumb, tenantid, appid to daily user sync script

Pour plus d'informations, veuillez cliquer sur ce lien.

À des fins de test, vous pouvez utiliser la méthode suivante pour vous connecter automatiquement à Azure AD avec la méthode de connexion sans surveillance et tester votre script avant d'exécuter le script de synchronisation des utilisateurs proprement dit :

$tenantid = "[fill in your tenant id from the output of the first script]" $thumb = "[fill in your thumb id from the output of the first script]" $appid = "[fill in your appid from the output of the first script]"
 Connect-AzureAD -TenantId $tenantid -ApplicationId $appid -CertificateThumbprint $thumb
 [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 $ErrorActionPreference = "Stop"
 $users_all = Get-AzureADUser -All $true | Where-Object {$_.userprincipalname -like "*someDomainname.com"} $users_all | Push-AzureADUsersToBB -UserDefaultRoleName $roleNameDefaultIfNoGroupMatched -GroupUserRoleMapping $groupToRoleMapping -DeactivateExistingUsersInSameIntegrationThatAreNotLoaded -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Étape 4.1 : Tester la sélection des utilisateurs

La commande pour obtenir l'information d'Active Directory et la traiter dans GoBright est :

Push-ADUsersToBB [filter] [optional: specific username/pincode field] -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]'

Vous pouvez utiliser les paramètres suivants dans la commande 'Push-ADUsersToBB' :

Vous trouverez ci-dessous plusieurs exemples de commandes. Vous pouvez les adapter à votre situation.

Ces commandes ne mettront pas encore à jour les utilisateurs dans le système. Il s'agit donc de commandes de test, car elles incluent le paramètre '-WhatIf'.

Exemples de commandes de test :

Traiter les utilisateurs dont le NUP se termine par 'yourdomain.com' :

Push-ADUsersToBB -Filter 'UserPrincipalName -like "*yourdomain.com"' -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter les utilisateurs dont le NUP se termine par 'yourdomain.com' et utiliser le champ 'PersonnelNumber' dans ActiveDirectory comme code postal pour les utilisateurs :

Push-ADUsersToBB -Filter 'UserPrincipalName -like "*yourdomain.com"' -ADUserPincodePropertyName PersonnelNumber -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter les utilisateurs qui sont membres d'un groupe spécifique dans une OU (Organizational Unit) :

Push-ADUsersToBB -Filter { memberOf -RecursiveMatch "CN=Administrators,DC=Company,DC=com" } -SearchBase "OU=Office,DC=Company,DC=com" -ADUserPincodePropertyName PersonnelNumber -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter les utilisateurs qui sont membres d'un groupe spécifique dans une OU (Organizational Unit) et définir un rôle spécifique en fonction de leur appartenance à un groupe :

$groupToRoleMapping = @()

 $groupToRoleMapping += @ # match specific users that belong to a group
 $groupToRoleMapping += @ # match specific users that belong to a group
 $groupToRoleMapping += @ # match specific users that belong to a group to a role of View
 $groupToRoleMapping += @ # **special case** this line matches for every user, because of the 'MatchType', and is needed when you want to have a generic role for every user
 $roleNameDefaultIfNoGroupMatched = "Regular user"
 Push-ADUsersToBB -Filter { memberOf -RecursiveMatch "CN=OfficeUsers,DC=Company,DC=com" } -SearchBase "OU=Office,DC=Company,DC=com" -ADUserPincodePropertyName PersonnelNumber -UserDefaultRoleName $roleNameDefaultIfNoGroupMatched -GroupUserRoleMapping $groupToRoleMapping -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Traiter les utilisateurs qui sont membres d'un groupe spécifique dans une OU (Organizational Unit), avec [domain][username] comme nom d'utilisateur d'authentification :

Push-ADUsersToBB -Filter { memberOf -RecursiveMatch "CN=Administrators,DC=Company,DC=com" } -SearchBase "OU=Office,DC=Company,DC=com" -ADSpecificUsername DomainPlusUsername -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]' -WhatIf

Dans un exemple où vous travaillez avec deux locataires Active Directory différents, mais que vous devez les relier à un seul environnement GoBright , vous pouvez utiliser le script d'exemple suivant :

Soyez conscient que le script ci-dessous ne supporte pas l'instruction -WhatIf. Lorsque vous exécutez ce script, les utilisateurs seront poussés de votre Active Directory vers GoBright.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

 $ErrorActionPreference = "Stop"
 $ADUsersProperties = @("SamAccountName","DistinguishedName","DisplayName","ProxyAddresses","Mail","MemberOf")

 If ($ADUserPincodePropertyName)
 {
 $ADUsersProperties += $ADUserPincodePropertyName 
$ConvertUsersParams.ADUserPincodePropertyName = $ADUserPincodePropertyName
 } 

 If ($ADUserNamePropertyName)
 {
 $ADUsersProperties += $ADUserNamePropertyName
 $ConvertUsersParams.ADUserNamePropertyName = $ADUserNamePropertyName
 }

 If ($ADUserMobilePropertyName)
 {
 $ADUsersProperties += $ADUserMobilePropertyName
 $ConvertUsersParams.ADUserMobilePropertyName = $ADUserMobilePropertyName
 }

 If ($ADUserNFCIdPropertyName)
 {
 $ADUsersProperties += $ADUserNFCIdPropertyName
 $ConvertUsersParams.ADUserNFCIdPropertyName = $ADUserNFCIdPropertyName
 }

 If ($ADUserDefaultCostCenterIdOrNamePropertyName)
 {
 $ADUsersProperties += $ADUserDefaultCostCenterIdOrNamePropertyName
 $ConvertUsersParams.ADUserDefaultCostCenterIdOrNamePropertyName = $ADUserDefaultCostCenterIdOrNamePropertyName
 }

 $groupToRoleMapping = @()
 $groupToRoleMapping += @
 $groupToRoleMapping += @ # **special case** this line matches for every user, because of the 'MatchType', and is needed when you want to have a generic role for every user

 

 #Get users from OU1 / or when adding -Server YourServername1.local from AD 1
 $users1 = Get-ADUser -Filter 'UserPrincipalName -like "*yourdomain.com"' -SearchBase "OU=Office-Sales,DC=Company,DC=com" -Properties $ADUsersProperties | Select-Object *
 -ADSpecificUsername DomainPlusUsername -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]'

 #Get users from OU1 / or when adding -Server YourServername2.local from AD 2
 $users2 = Get-ADUser -Filter 'UserPrincipalName -like "*yourdomain.com"' -SearchBase "OU=Office-Marketing,DC=Company,DC=com" -Properties $ADUsersProperties | Select-Object *
 -ADSpecificUsername DomainPlusUsername -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]'

 

 # merge the users to one list
$users_all = $users1 + $users2

 

 # Filter so we only get user objects
 $users_all = $users_all | Where-Object {$_.ObjectClass -eq "user"}
 $convertedUsers = $users_all | Convert-ADUsersToBBUserExport -GroupUserRoleMapping $groupToRoleMapping -ADSpecificUsername UserPrincipalName -UserDefaultRoleName "Default User Role"
 $convertedUsers

 

#Send users to GoBright
 Send-ADUsersToBB -pipelineConvertedADUsers $convertedUsers -DeactivateExistingUsersInSameIntegrationThatAreNotLoaded -BrightBookingApiUrl '[API url]' -BrightBookingApiKey '[API key]' -BrightBookingIntegrationName '[name of integration as created in Admin center > Integrations]'

Étape 4.2 : Exécuter la synchronisation réelle

Une fois que la liste des utilisateurs est correctement filtrée, vous pouvez exécuter la synchronisation réelle en supprimant le paramètre '-WhatIf'.

Exécutez maintenant la même commande, mais sans '-WhatIf' et elle traitera les utilisateurs dans votre environnement GoBright .

Étape 4.3 : Planifiez l'intégration pour qu'elle s'exécute périodiquement via le planificateur de tâches de Windows.

Suivez ces étapes pour synchroniser les utilisateurs depuis Active Directory selon un calendrier :

• Prenez la commande que vous avez composée (voir les étapes précédentes), et enregistrez-la dans un fichier .ps1 :
  • Créez un fichier .ps1 (par exemple UsersToBrightBooking.ps1) dans un dossier de votre choix.
  • Ouvrez le fichier avec un éditeur, par exemple 'notepad'.
  • Collez la commande complète dans le fichier
  • Sauvegarder le fichier
• Exécutez le fichier pour voir s'il est réussi.
• Créez une tâche dans le planificateur de tâches de Windows :
  • Ouvrir le planificateur de tâches de Windows
  • Créer une tâche
  • Définissez un calendrier, par exemple une fois par jour ou toutes les 4 heures.
  • Ajouter une action "Démarrer un programme" :
    • Programme/script :
      Powershell.exe
    • Paramètres :
      -windowstyle minimized -c "powershell -c .[Nom du fichier .ps1 créé] -verbose >> ExportToGoBright_Output.txt 2>&1″.
    • Start in :
      Remplissez le champ 'start in' avec l'emplacement du script, par exemple :C:scripts