< Back
Convert-ADUsersToBBUserExport
Post
NAME Convert-ADUsersToBBUserExport
SYNOPSIS
Convert-ADUsersToBBUserExport the user information from ActiveDirectory to the format needed for GoBright
BrightBooking
SYNTAX
Convert-ADUsersToBBUserExport -pipelineADUsers <Object[]> [[-ADUserPincodePropertyName] <String>]
[[-ADUserNamePropertyName] <String>] [-ADUserMobilePropertyName <String>] [-ADUserNFCIdPropertyName <String>]
[[-ADSpecificUsername] <String>] [-UserDefaultRoleName <String>] [-GroupUserRoleMapping <Object[]>]
[<CommonParameters>]
DESCRIPTION
Convert-ADUsersToBBUserExport the user information from ActiveDirectory to the format needed for GoBright
BrightBooking. Expecting the output of Get-ADUsersForBB
PARAMETERS
-pipelineADUsers <Object[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ADUserPincodePropertyName <String>
Optional ActiveDirectory User Property which contains the pincode
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNamePropertyName <String>
Optional ActiveDirectory User Property which contains the name of the user, in case you do not want to use the
default property
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserMobilePropertyName <String>
Required? false
Position? named
Default value Mobile
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNFCIdPropertyName <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADSpecificUsername <String>
Optional way to get a specific username from ActiveDirectory which should be used to authenticate the users
when he logs in into GoBright BrightBooking (app/portal). You can choose which username should be used,
DOMAIN\\UserName or the UserPrincipalName (UPN)
Required? false
Position? 4
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-UserDefaultRoleName <String>
Optional default name of role the role the user should get (will be assigned to every user, except for the
matches find in 'GroupUserRoleMapping')
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupUserRoleMapping <Object[]>
Optional map of ADGroupNames (by their distinguishedName) and the corresponding role name that should be
assigned. First match will be taken, and will override a potential given 'UserDefaultRoleName'
Examplestructure to supply in this parameter:
$groupToRoleMapping = @()
$groupToRoleMapping += @{ADDistinguishedName = "OU=GoBrightBookingManagers,OU=Groups,DC=company,DC=com";
RoleName = "Bookingmanagers"}
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-ADUsersForBB -Filter * | Convert-ADUsersToBBUserExport
# Get all users in the Active Directory and convert the information to the needed format
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ADUsersForBB -SearchBase "OU=Office,DC=Company,DC=com" -ADUserPincodePropertyName PersonnelNumber
-ADUserNamePropertyName FullUserName | Convert-ADUsersToBBUserExport -ADUserPincodePropertyName PersonnelNumber
-ADUserNamePropertyName FullUserName
# Get the users in the Active Directory, which in the specified SearchBase path, and use the custom property
'PersonnelNumber' as pincode, and the custom property 'FullUserName' as username
RELATED LINKS
https://support.gobright.com/
https://technet.microsoft.com/library/hh852208.aspx
Get-ADUsersForBB
Export-ADUsersToBB
SYNOPSIS
Convert-ADUsersToBBUserExport the user information from ActiveDirectory to the format needed for GoBright
BrightBooking
SYNTAX
Convert-ADUsersToBBUserExport -pipelineADUsers <Object[]> [[-ADUserPincodePropertyName] <String>]
[[-ADUserNamePropertyName] <String>] [-ADUserMobilePropertyName <String>] [-ADUserNFCIdPropertyName <String>]
[[-ADSpecificUsername] <String>] [-UserDefaultRoleName <String>] [-GroupUserRoleMapping <Object[]>]
[<CommonParameters>]
DESCRIPTION
Convert-ADUsersToBBUserExport the user information from ActiveDirectory to the format needed for GoBright
BrightBooking. Expecting the output of Get-ADUsersForBB
PARAMETERS
-pipelineADUsers <Object[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ADUserPincodePropertyName <String>
Optional ActiveDirectory User Property which contains the pincode
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNamePropertyName <String>
Optional ActiveDirectory User Property which contains the name of the user, in case you do not want to use the
default property
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADUserMobilePropertyName <String>
Required? false
Position? named
Default value Mobile
Accept pipeline input? false
Accept wildcard characters? false
-ADUserNFCIdPropertyName <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ADSpecificUsername <String>
Optional way to get a specific username from ActiveDirectory which should be used to authenticate the users
when he logs in into GoBright BrightBooking (app/portal). You can choose which username should be used,
DOMAIN\\UserName or the UserPrincipalName (UPN)
Required? false
Position? 4
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-UserDefaultRoleName <String>
Optional default name of role the role the user should get (will be assigned to every user, except for the
matches find in 'GroupUserRoleMapping')
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupUserRoleMapping <Object[]>
Optional map of ADGroupNames (by their distinguishedName) and the corresponding role name that should be
assigned. First match will be taken, and will override a potential given 'UserDefaultRoleName'
Examplestructure to supply in this parameter:
$groupToRoleMapping = @()
$groupToRoleMapping += @{ADDistinguishedName = "OU=GoBrightBookingManagers,OU=Groups,DC=company,DC=com";
RoleName = "Bookingmanagers"}
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-ADUsersForBB -Filter * | Convert-ADUsersToBBUserExport
# Get all users in the Active Directory and convert the information to the needed format
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ADUsersForBB -SearchBase "OU=Office,DC=Company,DC=com" -ADUserPincodePropertyName PersonnelNumber
-ADUserNamePropertyName FullUserName | Convert-ADUsersToBBUserExport -ADUserPincodePropertyName PersonnelNumber
-ADUserNamePropertyName FullUserName
# Get the users in the Active Directory, which in the specified SearchBase path, and use the custom property
'PersonnelNumber' as pincode, and the custom property 'FullUserName' as username
RELATED LINKS
https://support.gobright.com/
https://technet.microsoft.com/library/hh852208.aspx
Get-ADUsersForBB
Export-ADUsersToBB