< Back
Invoke-FreeIPAAPIuser_find
Post
NAME Invoke-FreeIPAAPIuser_find
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIuser_find [[-login] <String>] [[-first] <String>] [[-last] <String>] [[-cn] <String>]
[[-displayname] <String>] [[-initials] <String>] [[-homedir] <String>] [[-gecos] <String>] [[-shell] <String>]
[[-principal] <String[]>] [[-principal_expiration] <DateTime>] [[-password_expiration] <DateTime>] [[-email]
<String[]>] [[-password] <SecureString>] [[-uid] <Int32>] [[-gidnumber] <Int32>] [[-street] <String>] [[-city]
<String>] [[-state] <String>] [[-postalcode] <String>] [[-phone] <String[]>] [[-mobile] <String[]>] [[-pager]
<String[]>] [[-fax] <String[]>] [[-orgunit] <String>] [[-title] <String>] [[-manager] <String>] [[-carlicense]
<String[]>] [[-user_auth_type] <String[]>] [[-class] <String[]>] [[-radius] <String>] [[-radius_username]
<String>] [[-departmentnumber] <String[]>] [[-employeenumber] <String>] [[-employeetype] <String>]
[[-preferredlanguage] <String>] [[-certificate] <String[]>] [-disabled] [-preserved] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-whoami] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-in_groups]
<String[]>] [[-not_in_groups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>]
[[-in_roles] <String[]>] [[-not_in_roles] <String[]>] [[-in_hbacrules] <String[]>] [[-not_in_hbacrules]
<String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>] [[-criteria] <String>]
[-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for users.
PARAMETERS
-login <String>
User login
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-first <String>
First name
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-last <String>
Last name
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-cn <String>
Full name
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-displayname <String>
Display name
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-initials <String>
Initials
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-homedir <String>
Home directory
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-gecos <String>
GECOS
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-shell <String>
Login shell
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-principal <String[]>
Principal alias
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-principal_expiration <DateTime>
Kerberos principal expiration
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password_expiration <DateTime>
User password expiration
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-email <String[]>
Email address
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Prompt to set the user password
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-uid <Int32>
User ID Number (system will assign one if not provided)
Required? false
Position? 15
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-gidnumber <Int32>
Group ID Number
Required? false
Position? 16
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-street <String>
Street address
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-city <String>
City
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-state <String>
State/Province
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-postalcode <String>
ZIP
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-phone <String[]>
Telephone Number
Required? false
Position? 21
Default value
Accept pipeline input? false
Accept wildcard characters? false
-mobile <String[]>
Mobile Telephone Number
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-pager <String[]>
Pager Number
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-fax <String[]>
Fax Number
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-orgunit <String>
Org. Unit
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-title <String>
Job Title
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-manager <String>
Manager
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-carlicense <String[]>
Car License
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-user_auth_type <String[]>
Types of supported user authentication
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-class <String[]>
User category (semantics placed on this attribute are for local interpretation)
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-radius <String>
RADIUS proxy configuration
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-radius_username <String>
RADIUS proxy username
Required? false
Position? 32
Default value
Accept pipeline input? false
Accept wildcard characters? false
-departmentnumber <String[]>
Department Number
Required? false
Position? 33
Default value
Accept pipeline input? false
Accept wildcard characters? false
-employeenumber <String>
Employee Number
Required? false
Position? 34
Default value
Accept pipeline input? false
Accept wildcard characters? false
-employeetype <String>
Employee Type
Required? false
Position? 35
Default value
Accept pipeline input? false
Accept wildcard characters? false
-preferredlanguage <String>
Preferred Language
Required? false
Position? 36
Default value
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded user certificate
Required? false
Position? 37
Default value
Accept pipeline input? false
Accept wildcard characters? false
-disabled [<SwitchParameter>]
Account disabled
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-preserved [<SwitchParameter>]
Preserved user
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 38
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 39
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-whoami [<SwitchParameter>]
Display user record for current Kerberos principal
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 40
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-pkey_only [<SwitchParameter>]
Results should contain primary key attribute only ("login")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-in_groups <String[]>
Search for users with these member of groups.
Required? false
Position? 41
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_groups <String[]>
Search for users without these member of groups.
Required? false
Position? 42
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for users with these member of netgroups.
Required? false
Position? 43
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for users without these member of netgroups.
Required? false
Position? 44
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_roles <String[]>
Search for users with these member of roles.
Required? false
Position? 45
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_roles <String[]>
Search for users without these member of roles.
Required? false
Position? 46
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for users with these member of HBAC rules.
Required? false
Position? 47
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for users without these member of HBAC rules.
Required? false
Position? 48
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for users with these member of sudo rules.
Required? false
Position? 49
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for users without these member of sudo rules.
Required? false
Position? 50
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 51
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
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
System.Management.Automation.PSObject
RELATED LINKS
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIuser_find [[-login] <String>] [[-first] <String>] [[-last] <String>] [[-cn] <String>]
[[-displayname] <String>] [[-initials] <String>] [[-homedir] <String>] [[-gecos] <String>] [[-shell] <String>]
[[-principal] <String[]>] [[-principal_expiration] <DateTime>] [[-password_expiration] <DateTime>] [[-email]
<String[]>] [[-password] <SecureString>] [[-uid] <Int32>] [[-gidnumber] <Int32>] [[-street] <String>] [[-city]
<String>] [[-state] <String>] [[-postalcode] <String>] [[-phone] <String[]>] [[-mobile] <String[]>] [[-pager]
<String[]>] [[-fax] <String[]>] [[-orgunit] <String>] [[-title] <String>] [[-manager] <String>] [[-carlicense]
<String[]>] [[-user_auth_type] <String[]>] [[-class] <String[]>] [[-radius] <String>] [[-radius_username]
<String>] [[-departmentnumber] <String[]>] [[-employeenumber] <String>] [[-employeetype] <String>]
[[-preferredlanguage] <String>] [[-certificate] <String[]>] [-disabled] [-preserved] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-whoami] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-in_groups]
<String[]>] [[-not_in_groups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>]
[[-in_roles] <String[]>] [[-not_in_roles] <String[]>] [[-in_hbacrules] <String[]>] [[-not_in_hbacrules]
<String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>] [[-criteria] <String>]
[-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for users.
PARAMETERS
-login <String>
User login
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-first <String>
First name
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-last <String>
Last name
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-cn <String>
Full name
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-displayname <String>
Display name
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-initials <String>
Initials
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-homedir <String>
Home directory
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-gecos <String>
GECOS
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-shell <String>
Login shell
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-principal <String[]>
Principal alias
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-principal_expiration <DateTime>
Kerberos principal expiration
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password_expiration <DateTime>
User password expiration
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-email <String[]>
Email address
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Prompt to set the user password
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-uid <Int32>
User ID Number (system will assign one if not provided)
Required? false
Position? 15
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-gidnumber <Int32>
Group ID Number
Required? false
Position? 16
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-street <String>
Street address
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-city <String>
City
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-state <String>
State/Province
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-postalcode <String>
ZIP
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-phone <String[]>
Telephone Number
Required? false
Position? 21
Default value
Accept pipeline input? false
Accept wildcard characters? false
-mobile <String[]>
Mobile Telephone Number
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-pager <String[]>
Pager Number
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-fax <String[]>
Fax Number
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-orgunit <String>
Org. Unit
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-title <String>
Job Title
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-manager <String>
Manager
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-carlicense <String[]>
Car License
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-user_auth_type <String[]>
Types of supported user authentication
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-class <String[]>
User category (semantics placed on this attribute are for local interpretation)
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-radius <String>
RADIUS proxy configuration
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-radius_username <String>
RADIUS proxy username
Required? false
Position? 32
Default value
Accept pipeline input? false
Accept wildcard characters? false
-departmentnumber <String[]>
Department Number
Required? false
Position? 33
Default value
Accept pipeline input? false
Accept wildcard characters? false
-employeenumber <String>
Employee Number
Required? false
Position? 34
Default value
Accept pipeline input? false
Accept wildcard characters? false
-employeetype <String>
Employee Type
Required? false
Position? 35
Default value
Accept pipeline input? false
Accept wildcard characters? false
-preferredlanguage <String>
Preferred Language
Required? false
Position? 36
Default value
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded user certificate
Required? false
Position? 37
Default value
Accept pipeline input? false
Accept wildcard characters? false
-disabled [<SwitchParameter>]
Account disabled
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-preserved [<SwitchParameter>]
Preserved user
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 38
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 39
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-whoami [<SwitchParameter>]
Display user record for current Kerberos principal
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 40
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-pkey_only [<SwitchParameter>]
Results should contain primary key attribute only ("login")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-in_groups <String[]>
Search for users with these member of groups.
Required? false
Position? 41
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_groups <String[]>
Search for users without these member of groups.
Required? false
Position? 42
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for users with these member of netgroups.
Required? false
Position? 43
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for users without these member of netgroups.
Required? false
Position? 44
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_roles <String[]>
Search for users with these member of roles.
Required? false
Position? 45
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_roles <String[]>
Search for users without these member of roles.
Required? false
Position? 46
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for users with these member of HBAC rules.
Required? false
Position? 47
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for users without these member of HBAC rules.
Required? false
Position? 48
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for users with these member of sudo rules.
Required? false
Position? 49
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for users without these member of sudo rules.
Required? false
Position? 50
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 51
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
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
System.Management.Automation.PSObject
RELATED LINKS