Name
Invoke-JS7IAMChangePassword
SYNOPSIS
Modifies the password of an account in a JOC Cockpit Identity Service
SYNTAX
Invoke-JS7IAMChangePassword [-Service] <String> [-Account] <String> [-Password] <SecureString> [-NewPassword] <SecureString> [-ForcePasswordChange] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet modifies the password of an account in a JOC Cockpit Identity Service.
The following REST Web Service API resources are used:
* /iam/account/changepassword
PARAMETERS
Service
-Service <String>
Specifies the unique name of the Identity Service that accounts are managed with.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Account
-Account <String>
Specifies the unique name of an account for which the password should be modified.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Password
-Password <SecureString>
Specifies the account's existing password.
The password has to be specified as a secure string, for example:
$oldPassword = ConvertTo-SecureString 'secret' -AsPlainText -Force
| Required? | true |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NewPassword
-NewPassword <SecureString>
Specifies the account's new password.
The password has to be specified as a secure string, for example:
$newPassword = ConvertTo-SecureString 'very-secret' -AsPlainText -Force
| Required? | true |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ForcePasswordChange
-ForcePasswordChange <SwitchParameter>
Specifies that the account has to change the password with the next login.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
| Required? | false |
| Position? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $oldPassword = ConvertTo-SecureString 'secret' -AsPlainText -Force;
$newPassword = ConvertTo-SecureString 'very-secret' -AsPlainText -Force;
Invoke-JS7IAMChangePassword -Service 'JOC' -Account 'user1' -Password $oldPassword -NewPassword $newPassword
Sets the account's password.
Overview
Content Tools