< Back
Push-AzureADUsersToBB
Post
NAME Push-AzureADUsersToBB
SYNOPSIS
Takes users via the pipeline from Get-AzureADUser, converts the information needed and process it directly in
GoBright BrightBooking
SYNTAX
Push-AzureADUsersToBB [-pipelineAzureADUsers] <Object[]> [[-ADUserNamePropertyName] <String>]
[[-ADUserPincodePropertyName] <String>] [[-ADUserMobilePropertyName] <String>] [[-ADUserNFCIdPropertyName]
<String>] [-BrightBookingApiUrl] <String> [-BrightBookingApiKey] <String> [-BrightBookingIntegrationName] <String>
[[-UserRoleNameForNewUsers] <String>] [-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Takes users via the pipeline from Get-AzureADUser, converts the information needed and process it directly in
GoBright BrightBooking
PARAMETERS
-pipelineAzureADUsers <Object[]>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ADUserNamePropertyName <String>
Optional AzureAd User Property which contains the name of the user, in case you do not want to use the default
property
Required? false
Position? 2
Default value DisplayName
Accept pipeline input? false
Accept wildcard characters? false
-ADUserPincodePropertyName <String>
Optional AzureAd User Property which contains the pincode
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserMobilePropertyName <String>
Optional AzureAd User Property which contains the mobile phone number
Required? false
Position? 4
Default value Mobile
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNFCIdPropertyName <String>
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingApiUrl <String>
Address of the GoBright BrightBooking API, e.g.: https://eu1.api.brightbooking.eu/
Required? true
Position? 6
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? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingIntegrationName <String>
Name of the GoBright integration to link the users to
Required? true
Position? 8
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? 9
Default value
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
-WhatIf [<SwitchParameter>]
Use the WhatIf switch to print out the retreived users, without processing them to the API. This is usefull
for testing purposes
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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-AzureADUser | Push-AzureADUsersToBB -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
RELATED LINKS
Get-AzureADUser
SYNOPSIS
Takes users via the pipeline from Get-AzureADUser, converts the information needed and process it directly in
GoBright BrightBooking
SYNTAX
Push-AzureADUsersToBB [-pipelineAzureADUsers] <Object[]> [[-ADUserNamePropertyName] <String>]
[[-ADUserPincodePropertyName] <String>] [[-ADUserMobilePropertyName] <String>] [[-ADUserNFCIdPropertyName]
<String>] [-BrightBookingApiUrl] <String> [-BrightBookingApiKey] <String> [-BrightBookingIntegrationName] <String>
[[-UserRoleNameForNewUsers] <String>] [-DeactivateExistingUsersInSameIntegrationThatAreNotLoaded] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Takes users via the pipeline from Get-AzureADUser, converts the information needed and process it directly in
GoBright BrightBooking
PARAMETERS
-pipelineAzureADUsers <Object[]>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ADUserNamePropertyName <String>
Optional AzureAd User Property which contains the name of the user, in case you do not want to use the default
property
Required? false
Position? 2
Default value DisplayName
Accept pipeline input? false
Accept wildcard characters? false
-ADUserPincodePropertyName <String>
Optional AzureAd User Property which contains the pincode
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserMobilePropertyName <String>
Optional AzureAd User Property which contains the mobile phone number
Required? false
Position? 4
Default value Mobile
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNFCIdPropertyName <String>
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingApiUrl <String>
Address of the GoBright BrightBooking API, e.g.: https://eu1.api.brightbooking.eu/
Required? true
Position? 6
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? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BrightBookingIntegrationName <String>
Name of the GoBright integration to link the users to
Required? true
Position? 8
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? 9
Default value
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
-WhatIf [<SwitchParameter>]
Use the WhatIf switch to print out the retreived users, without processing them to the API. This is usefull
for testing purposes
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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-AzureADUser | Push-AzureADUsersToBB -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
RELATED LINKS
Get-AzureADUser