< Back
Send-ADUsersToBB
Post
NAME Send-ADUsersToBB
SYNOPSIS
Get the user information from the pipeline that is already converted to a GoBright BrightBooking object, and send
it to the GoBright BrightBooking system
SYNTAX
Send-ADUsersToBB [-pipelineConvertedADUsers] <Object[]> [-BrightBookingApiUrl] <String> [-BrightBookingApiKey]
<String> [-BrightBookingIntegrationName] <String> [[-UserRoleNameForNewUsers] <String>] [[-SyncIncludesUserNFCId]
<Boolean>] [[-SyncIncludesUserPincode] <Boolean>] [-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded]
[<CommonParameters>]
DESCRIPTION
The pipeline should contain the converted user information
PARAMETERS
-pipelineConvertedADUsers <Object[]>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-BrightBookingApiUrl <String>
Address of the GoBright BrightBooking API, e.g.: https://eu1.api.brightbooking.eu/
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingApiKey <String>
API key of the user to use to process the import
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingIntegrationName <String>
Name of the integration to link the users to
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserRoleNameForNewUsers <String>
Name of the GoBright userrole to link new users to
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SyncIncludesUserNFCId <Boolean>
Required? false
Position? 6
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SyncIncludesUserPincode <Boolean>
Required? false
Position? 7
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded [<SwitchParameter>]
Deactivate users that exist in the platform in the same integration but are not loaded anymore from AD (e.g.
because they are not anymore in the group you filter on)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ADUsersForBB -Filter * | Convert-ADUsersToBBUserExport | Send-ADUsersToBB -BrightBookingApiUrl
"https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]" -BrightBookingIntegrationName "Office
365"
# Get all users in the Active Directory and let GoBright BrightBooking process it directly
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ADUsersForBB -Filter * -SearchBase "OU=Office,DC=Company,DC=com" | Convert-ADUsersToBBUserExport |
Send-ADUsersToBB -BrightBookingApiUrl "https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]"
-BrightBookingIntegrationName "Office 365"
# Get the users in the Active Directory, which are member of the given group and let GoBright BrightBooking
process it directly
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-ADUsersForBB -Filter { memberOf -RecursiveMatch "CN=Administrators,DC=Company,DC=com" } -SearchBase
"OU=Office,DC=Company,DC=com" | Convert-ADUsersToBBUserExport -ADUserPincodePropertyName PersonnelNumber |
Send-ADUsersToBB -BrightBookingApiUrl "https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]"
-BrightBookingIntegrationName "Office 365"
# Get the users in the Active Directory, which in the specified SearchBase path, and use the custom property
'PersonnelNumber' as pincode and let GoBright BrightBooking process it directly
RELATED LINKS
https://support.gobright.com/
SYNOPSIS
Get the user information from the pipeline that is already converted to a GoBright BrightBooking object, and send
it to the GoBright BrightBooking system
SYNTAX
Send-ADUsersToBB [-pipelineConvertedADUsers] <Object[]> [-BrightBookingApiUrl] <String> [-BrightBookingApiKey]
<String> [-BrightBookingIntegrationName] <String> [[-UserRoleNameForNewUsers] <String>] [[-SyncIncludesUserNFCId]
<Boolean>] [[-SyncIncludesUserPincode] <Boolean>] [-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded]
[<CommonParameters>]
DESCRIPTION
The pipeline should contain the converted user information
PARAMETERS
-pipelineConvertedADUsers <Object[]>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-BrightBookingApiUrl <String>
Address of the GoBright BrightBooking API, e.g.: https://eu1.api.brightbooking.eu/
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingApiKey <String>
API key of the user to use to process the import
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingIntegrationName <String>
Name of the integration to link the users to
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserRoleNameForNewUsers <String>
Name of the GoBright userrole to link new users to
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SyncIncludesUserNFCId <Boolean>
Required? false
Position? 6
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SyncIncludesUserPincode <Boolean>
Required? false
Position? 7
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded [<SwitchParameter>]
Deactivate users that exist in the platform in the same integration but are not loaded anymore from AD (e.g.
because they are not anymore in the group you filter on)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ADUsersForBB -Filter * | Convert-ADUsersToBBUserExport | Send-ADUsersToBB -BrightBookingApiUrl
"https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]" -BrightBookingIntegrationName "Office
365"
# Get all users in the Active Directory and let GoBright BrightBooking process it directly
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ADUsersForBB -Filter * -SearchBase "OU=Office,DC=Company,DC=com" | Convert-ADUsersToBBUserExport |
Send-ADUsersToBB -BrightBookingApiUrl "https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]"
-BrightBookingIntegrationName "Office 365"
# Get the users in the Active Directory, which are member of the given group and let GoBright BrightBooking
process it directly
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-ADUsersForBB -Filter { memberOf -RecursiveMatch "CN=Administrators,DC=Company,DC=com" } -SearchBase
"OU=Office,DC=Company,DC=com" | Convert-ADUsersToBBUserExport -ADUserPincodePropertyName PersonnelNumber |
Send-ADUsersToBB -BrightBookingApiUrl "https://eu1.api.brightbooking.eu/" -BrightBookingApiKey "[your api key]"
-BrightBookingIntegrationName "Office 365"
# Get the users in the Active Directory, which in the specified SearchBase path, and use the custom property
'PersonnelNumber' as pincode and let GoBright BrightBooking process it directly
RELATED LINKS
https://support.gobright.com/