Get-AdSyncHiddenObject cmdlet is used to display hidden objects of another Active Directory, which are not linked with corresponding objects in CP: Users, Company contacts, Distribution lists. These objects cannot be linked using Set-ADSyncObjectLinked cmdlet.

Input parameters

#
Parameter
Type

Mandatory (R/O)

Description
Valid Values
1 Authentication Information (all parameters)  
2 Count int O The number of the returned items (after Offset parameter is specified and processed)

Min value is 1, max - 1000.

If not specified, equals to 100 (the default value).

3 Filter string O This parameter allows to filter values by condition

 


4

Identity

(aliases: ObjectID, DistinguishedName, EmailAddress, Name)

string O A property, that identifies the object of another Active Directory

Value of one of these parameters  can be used as Identity:

#ParameterDescription
1 ObjectID GUID of the object in another AD
2 DistinguishedName Unique name of the object in another Active Directory
3 EmailAddress Email of the object in another Active Directory
4 Name Name of the object in another Active Directory
5 ObjectType string[] O Type of the object
  • User
  • Contact - Company contact in CP
  • Group - Distribution List in CP
6 Offset int O A number of the item, starting from which the items should be returned

Min value is 1.

If not specified, equals to 1 (the default value)

Output parameters

#
Property
Type
Description
Valid Values
 ADSyncObjectInfo:
1 DistinguishedName string Unique name of the object in another Active Directory  
2 EmailAddress string Email of the object in another Active Directory  
3 Name string Name of the object in another Active Directory  
4 ObjectID Guid GUID of the object in another AD

 

5 ObjectType string Type of the object
  • User
  • Contact
  • Group
6 WhenCreated dateTime? The property defines, when the object was created in another Active Directory  

Examples of using Get-AdSyncHiddenObject cmdlet 

Getting all hidden objects from another Active Directory:

Get-AdSyncHiddenObject

Getting the hidden object with EmailAddress "test@test.test" from another Active Directory:

Get-AdSyncHiddenObject -Identity "test@test.test"

Getting hidden objects with ObjectType "User" or "Contact" from another Active Directory:

Get-AdSyncHiddenObject -ObjectType User, Contact