< Back
Get-JCUser
Post
NAME Get-JCUser
SYNOPSIS
Returns all JumpCloud Users within a JumpCloud tenant or searches for a JumpCloud User by 'username', 'firstname',
'lastname', or 'email'.
SYNTAX
Get-JCUser [[-username] <System.String>] [-account_locked <System.Boolean>] [-activated <System.Boolean>]
[-allow_public_key <System.Boolean>] [-company <System.String>] [-costCenter <System.String>] -date
<System.String> -dateFilter {before | after} [-department <System.String>] [-description <System.String>]
[-displayname <System.String>] [-email <System.String>] [-employeeIdentifier <System.String>] [-employeeType
<System.String>] [-enable_managed_uid <System.Boolean>] [-enable_user_portal_multifactor <System.Boolean>]
[-external_dn <System.String>] [-external_source_type <System.String>] [-externally_managed <System.Boolean>]
[-filterDateProperty {created | password_expiration_date}] [-firstname <System.String>] [-jobTitle
<System.String>] [-lastname <System.String>] [-ldap_binding_user <System.Boolean>] [-location <System.String>]
[-middlename <System.String>] [-password_expired <System.Boolean>] [-password_never_expires <System.Boolean>]
[-passwordless_sudo <System.Boolean>] [-returnProperties {created | password_expiration_date | account_locked |
activated | addresses | allow_public_key | attributes | email | enable_managed_uid |
enable_user_portal_multifactor | externally_managed | firstname | lastname | ldap_binding_user | passwordless_sudo
| password_expired | password_never_expires | phoneNumbers | samba_service_user | ssh_keys | sudo | totp_enabled |
unix_guid | unix_uid | username | middlename | displayname | jobTitle | employeeIdentifier | department |
costCenter | company | employeeType | description | location | external_source_type | external_dn | suspended}]
[-samba_service_user <System.Boolean>] [-sudo <System.Boolean>] [-suspended <System.Boolean>] [-totp_enabled
<System.Boolean>] [-unix_guid <System.String>] [-unix_uid <System.String>] [<CommonParameters>]
Get-JCUser -date <System.String> -dateFilter {before | after} -userid <System.String> [<CommonParameters>]
DESCRIPTION
The Get-JCUser function returns all information describing a JumpCloud user. By default it will return all Users.
PARAMETERS
-account_locked <System.Boolean>
A search filter to return users that are in a locked ($true) or unlocked ($false) state.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-activated <System.Boolean>
A search filter to return users that are activated ($true) or those that have not set a password ($false).
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allow_public_key <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($true) to allow_public_key
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-company <System.String>
The company of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-costCenter <System.String>
The costCenter of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-date <System.String>
Date to filter on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-dateFilter <System.String>
Condition to filter date on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-department <System.String>
The department of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-description <System.String>
The description of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-displayname <System.String>
The preferred name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-email <System.String>
The Email of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-employeeIdentifier <System.String>
The employeeIdentifier of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-employeeType <System.String>
The employeeType of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-enable_managed_uid <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for enable_managed_uid
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-enable_user_portal_multifactor <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for
enable_user_portal_multifactor
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-external_dn <System.String>
The distinguished name of the AD domain (ADB Externally managed users only)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-external_source_type <System.String>
The externally managed user source type (ADB Externally managed users only)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-externally_managed <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for externally_managed
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-filterDateProperty <System.String>
A parameter that can filter the properties 'created' or 'password_expiration_date'. This parameter if used
creates two more dynamic parameters 'dateFilter' and 'date'. See EXAMPLE 4 above for full syntax.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-firstname <System.String>
The First Name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-jobTitle <System.String>
The jobTitle of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-lastname <System.String>
The Last Name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ldap_binding_user <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for ldap_binding_user
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-location <System.String>
The location of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-middlename <System.String>
The middlename of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-password_expired <System.Boolean>
A search filter to show accounts that have expired passwords ($true) or valid passwords ($false)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-password_never_expires <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for password_never_expires
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-passwordless_sudo <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for passwordless_sudo
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-returnProperties <System.String[]>
Allows you to return select properties on JumpCloud user objects. Specifying what properties are returned can
drastically increase the speed of the API call with a large data set. Valid properties that can be returned
are: 'created', 'password_expiration_date', 'account_locked', 'activated', 'addresses', 'allow_public_key',
'attributes', 'email', 'enable_managed_uid', 'enable_user_portal_multifactor', 'externally_managed',
'firstname', 'lastname', 'ldap_binding_user', 'passwordless_sudo', 'password_expired',
'password_never_expires', 'phoneNumbers', 'samba_service_user', 'ssh_keys', 'sudo', 'totp_enabled',
'unix_guid', 'unix_uid', 'username','suspended'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-samba_service_user <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for samba_service_user
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-sudo <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for sudo
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-suspended <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for password_never_expires
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-totp_enabled <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for totp_enabled
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-unix_guid <System.String>
A search filter to search for users with a specific unix_gid. DOES NOT accept wild card input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-unix_uid <System.String>
A search filter to search for users with a specific unix_uid. DOES NOT accept wild card input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-userid <System.String>
The _id of the User which you want to modify. UserID has an Alias of _id. This means you can leverage the
PowerShell pipeline to populate this field automatically.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-username <System.String>
The Username of the JumpCloud user you wish to search for.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.String
System.Boolean
System.String[]
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-JCUser
Returns all JumpCloud Users and the information describing these users.
-------------------------- Example 2 --------------------------
Get-JCUser -Username cclemons
Returns the information describing the JumpCloud User with Username cclemons
-------------------------- Example 3 --------------------------
Get-JCUser -Username *clemons
Returns all JumpCloud users that usernames end with clemons using the wildcard character '*'
-------------------------- Example 4 --------------------------
Get-JCUser -filterDateProperty created -dateFilter after -date 01/01/2018
Returns all JumpCloud users that were created after '01/01/2018'. The parameter '-filterDateProperty' takes both
'created' and 'password_expiration_date' as input and creates two dynamic parameters '-dateFilter' which takes
"before" or "after" as input and "-date" which takes a date value as input.
-------------------------- Example 5 --------------------------
Get-JCUser -returnProperties username, sudo
Returns all JumpCloud users and only the username and sudo Properties of their JumpCloud user object.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support/wiki/Get-JCUser
SYNOPSIS
Returns all JumpCloud Users within a JumpCloud tenant or searches for a JumpCloud User by 'username', 'firstname',
'lastname', or 'email'.
SYNTAX
Get-JCUser [[-username] <System.String>] [-account_locked <System.Boolean>] [-activated <System.Boolean>]
[-allow_public_key <System.Boolean>] [-company <System.String>] [-costCenter <System.String>] -date
<System.String> -dateFilter {before | after} [-department <System.String>] [-description <System.String>]
[-displayname <System.String>] [-email <System.String>] [-employeeIdentifier <System.String>] [-employeeType
<System.String>] [-enable_managed_uid <System.Boolean>] [-enable_user_portal_multifactor <System.Boolean>]
[-external_dn <System.String>] [-external_source_type <System.String>] [-externally_managed <System.Boolean>]
[-filterDateProperty {created | password_expiration_date}] [-firstname <System.String>] [-jobTitle
<System.String>] [-lastname <System.String>] [-ldap_binding_user <System.Boolean>] [-location <System.String>]
[-middlename <System.String>] [-password_expired <System.Boolean>] [-password_never_expires <System.Boolean>]
[-passwordless_sudo <System.Boolean>] [-returnProperties {created | password_expiration_date | account_locked |
activated | addresses | allow_public_key | attributes | email | enable_managed_uid |
enable_user_portal_multifactor | externally_managed | firstname | lastname | ldap_binding_user | passwordless_sudo
| password_expired | password_never_expires | phoneNumbers | samba_service_user | ssh_keys | sudo | totp_enabled |
unix_guid | unix_uid | username | middlename | displayname | jobTitle | employeeIdentifier | department |
costCenter | company | employeeType | description | location | external_source_type | external_dn | suspended}]
[-samba_service_user <System.Boolean>] [-sudo <System.Boolean>] [-suspended <System.Boolean>] [-totp_enabled
<System.Boolean>] [-unix_guid <System.String>] [-unix_uid <System.String>] [<CommonParameters>]
Get-JCUser -date <System.String> -dateFilter {before | after} -userid <System.String> [<CommonParameters>]
DESCRIPTION
The Get-JCUser function returns all information describing a JumpCloud user. By default it will return all Users.
PARAMETERS
-account_locked <System.Boolean>
A search filter to return users that are in a locked ($true) or unlocked ($false) state.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-activated <System.Boolean>
A search filter to return users that are activated ($true) or those that have not set a password ($false).
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allow_public_key <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($true) to allow_public_key
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-company <System.String>
The company of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-costCenter <System.String>
The costCenter of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-date <System.String>
Date to filter on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-dateFilter <System.String>
Condition to filter date on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-department <System.String>
The department of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-description <System.String>
The description of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-displayname <System.String>
The preferred name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-email <System.String>
The Email of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-employeeIdentifier <System.String>
The employeeIdentifier of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-employeeType <System.String>
The employeeType of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-enable_managed_uid <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for enable_managed_uid
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-enable_user_portal_multifactor <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for
enable_user_portal_multifactor
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-external_dn <System.String>
The distinguished name of the AD domain (ADB Externally managed users only)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-external_source_type <System.String>
The externally managed user source type (ADB Externally managed users only)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-externally_managed <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for externally_managed
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-filterDateProperty <System.String>
A parameter that can filter the properties 'created' or 'password_expiration_date'. This parameter if used
creates two more dynamic parameters 'dateFilter' and 'date'. See EXAMPLE 4 above for full syntax.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-firstname <System.String>
The First Name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-jobTitle <System.String>
The jobTitle of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-lastname <System.String>
The Last Name of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ldap_binding_user <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for ldap_binding_user
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-location <System.String>
The location of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-middlename <System.String>
The middlename of the JumpCloud user you wish to search for.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-password_expired <System.Boolean>
A search filter to show accounts that have expired passwords ($true) or valid passwords ($false)
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-password_never_expires <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for password_never_expires
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-passwordless_sudo <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for passwordless_sudo
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-returnProperties <System.String[]>
Allows you to return select properties on JumpCloud user objects. Specifying what properties are returned can
drastically increase the speed of the API call with a large data set. Valid properties that can be returned
are: 'created', 'password_expiration_date', 'account_locked', 'activated', 'addresses', 'allow_public_key',
'attributes', 'email', 'enable_managed_uid', 'enable_user_portal_multifactor', 'externally_managed',
'firstname', 'lastname', 'ldap_binding_user', 'passwordless_sudo', 'password_expired',
'password_never_expires', 'phoneNumbers', 'samba_service_user', 'ssh_keys', 'sudo', 'totp_enabled',
'unix_guid', 'unix_uid', 'username','suspended'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-samba_service_user <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for samba_service_user
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-sudo <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for sudo
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-suspended <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for password_never_expires
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-totp_enabled <System.Boolean>
A search filter to show accounts that are enabled ($true) or disabled ($false) for totp_enabled
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-unix_guid <System.String>
A search filter to search for users with a specific unix_gid. DOES NOT accept wild card input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-unix_uid <System.String>
A search filter to search for users with a specific unix_uid. DOES NOT accept wild card input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-userid <System.String>
The _id of the User which you want to modify. UserID has an Alias of _id. This means you can leverage the
PowerShell pipeline to populate this field automatically.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-username <System.String>
The Username of the JumpCloud user you wish to search for.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.String
System.Boolean
System.String[]
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-JCUser
Returns all JumpCloud Users and the information describing these users.
-------------------------- Example 2 --------------------------
Get-JCUser -Username cclemons
Returns the information describing the JumpCloud User with Username cclemons
-------------------------- Example 3 --------------------------
Get-JCUser -Username *clemons
Returns all JumpCloud users that usernames end with clemons using the wildcard character '*'
-------------------------- Example 4 --------------------------
Get-JCUser -filterDateProperty created -dateFilter after -date 01/01/2018
Returns all JumpCloud users that were created after '01/01/2018'. The parameter '-filterDateProperty' takes both
'created' and 'password_expiration_date' as input and creates two dynamic parameters '-dateFilter' which takes
"before" or "after" as input and "-date" which takes a date value as input.
-------------------------- Example 5 --------------------------
Get-JCUser -returnProperties username, sudo
Returns all JumpCloud users and only the username and sudo Properties of their JumpCloud user object.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support/wiki/Get-JCUser