Name
Set-JS7IAMAccount
SYNOPSIS
Stores an account to a JOC Cockpit Identity Service
SYNTAX
Set-JS7IAMAccount [-Service] <String> [-Account] <String> [[-Password] <SecureString>] [-Disabled] [-ForcePasswordChange] [-Role] <String[]> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet stores an account to a JOC Cockpit Identity Service.
The following REST Web Service API resources are used:
* /iam/account/store
PARAMETERS
Service
-Service <String>
Specifies the unique name of the Identity Service that the accounts is 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 the account that should be managed.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Password
-Password <SecureString>
Optionally specifies the account's password. If this parameter is not used then the initial password
managed with the JOC Cockpit Identity Service settings is used.
The password has to be specified as a secure string, for example:
$securePassword = ConvertTo-SecureString 'secret' -AsPlainText -Force
Set-JS7IAMAccount -Service JOC -Account 'user1' -Password $secureString -Role 'application_manager
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Disabled
-Disabled <SwitchParameter>
Specifies that the account cannot be used to login.
| Required? | false |
| Position? | named |
| Default value | False |
| 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 |
Role
-Role <String[]>
Specifies the unique names of one or more roles that are assigned the account.
| Required? | true |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention,
e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This argument is not mandatory, however, JOC Cockpit can be configured
to enforce Audit Log comments for any interventions.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.
| Required? | false |
| Position? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
| 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 > Set-JS7IAMAccount -Service JOC -Account 'user1' -Role 'application_manager'
Adds an account to JOC Cockpit that is assigned the indicated role. The account is assigned the initial password that is configured with the global Identity Service settings. On first login the account has to change the password.
-------------------------- EXAMPLE 2 --------------------------
PS > $securePassword = ConvertTo-SecureString 'secret' -AsPlainText -Force
Set-JS7IAMAccount -Service JOC -Account 'user1' -Password $secureString -Role 'application_manager','incident_manager'
Adds an account to JOC Cockpit that is assigned a password and the indicated roles.
Overview
Content Tools