< Back

Send-JCPasswordReset

Thu Jan 16, 2020 9:16 am

NAME Send-JCPasswordReset



SYNOPSIS

Sends a JumpCloud activation/password reset email.





SYNTAX

Send-JCPasswordReset [[-UserID] <System.String>] [<CommonParameters>]



Send-JCPasswordReset [[-username] <System.String>] [<CommonParameters>]





DESCRIPTION

The Send-JCPasswordReset command sends a JumpCloud activation/password reset email to targeted users. This

function mimics the functionality of the 'resend email' button in the JumpCloud admin console. Pending users will

recieve an activation email. Active users will receive a password reset request.





PARAMETERS

-UserID <System.String>

The _id of the User which you want to send the email. To find a JumpCloud UserID run the command: PS C:\\>

Get-JCUser | Select username, _id



The UserID will be the 24 character string populated for the _id field.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-username <System.String>

The Username of the JumpCloud user you wish to send the email.



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







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



Send-JCPasswordReset -username jcuser.one



Sends an activation or reset email to JumpCloud user with username 'jcuser.one'

-------------------------- Example 2 --------------------------



Get-JCUserGroupMember -GroupName NewUsers | Send-JCPasswordReset



Sends an activation or reset email to all members of the JumpCloud user group 'NewUsers'.

-------------------------- Example 3 --------------------------



Get-JCUser -activated $false | Send-JCPasswordReset



Sends an activation email to all JumpCloud users who are in an inactive state. Users that are inactive have not

yet set their JumpCloud user passwords.

-------------------------- Example 4 --------------------------



Get-JCUser -activated $false -filterDateProperty created -dateFilter after -date (Get-Date).AddDays(-7)

-returnProperties username | Send-JCPasswordReset



Sends an activation email to all JumpCloud users who are in an inactive state and were created in the last seven

days. Users that are inactive have not yet set their JumpCloud user passwords.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... swordReset