Name
New-JS7SigningKey
SYNOPSIS
Creates a new key pair for the current accounts
SYNTAX
New-JS7SigningKey [-KeyAlgorithm] <String> [[-ValidUntil] <DateTime>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a key pair of private key and public key/certificate of the current account.
JS7 supports the following key types: PGP, RSA and ECDSA.
* PGP keys use a private key and a public key.
* RSA and ECDSA use a private key and a signed certificate. The certificate can be self-signed or CA-signed. The public key is not used.
Depending on the security level that JOC Cockpit is operated for one of the following items is returned:
* public key/certificate if security level HIGH is used.
* public key/certificate and private key if security level LOW or MEDIUM are used.
The following REST Web Service API resources are used:
* /profile/key/generate
PARAMETERS
KeyAlgorithm
-KeyAlgorithm <String>
JS7 supports the following key algorithms: PGP, RSA and ECDSA.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ValidUntil
-ValidUntil <DateTime>
Specifies the limit of validit of the newly created key. The date is specified for the UTC timezone.
| Required? | false |
| Position? | 2 |
| 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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.
| Required? | false |
| Position? | 3 |
| 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 shown in 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? | 4 |
| 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 JS7.
This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.
| Required? | false |
| Position? | 5 |
| 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 > $key = New-JS7SigningKey -KeyAlgorithm PGP
A PGP key pair of private key and public key is created.
-------------------------- EXAMPLE 2 --------------------------
PS > $key = New-JS7SigningKey -KeyAlgorithm ECDSA
An ECDSA private key is created. Consider that this key requires a self-signed or CA-signed certificate that can be added by use of the Add-JS7SigningKey cmdlet.
Overview
Content Tools