Name
Set-JS7IAMService
SYNOPSIS
Stores a JOC Cockpit Identity Service
SYNTAX
Set-JS7IAMService [-Service] <String> [-Type] <String> [[-Ordering] <Int32>] [-Required] [-Disabled] [-SecondFactor] [[-AuthenticationScheme] <String>] [-SingleFactorCertificate] [-SingleFactorPassword] [[-SecondFactorService] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet stores a JOC Cockpit Identity Service.
The following REST Web Service API resources are used:
* /iam/identityservice/store
PARAMETERS
Service
-Service <String>
Specifies the unique name of the Identity Service.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Type
-Type <String>
Specifies the type of the Identity Service which is one of:
* CERTIFICATE: allow access from certificates, manage roles with JOC Cockpit
* FIDO: manage accounts from FIDO, manage roles with JOC Cockpit
* JOC: manage accounts and roles with JOC Cockpit
* KEYCLOAK: manage accounts and roles with Keycloak Server
* KEYCLOAK-JOC: manage accounts with Keycloak Server, mange roles with JOC Cockpit
* LDAP: manage accounts and roles with LDAP Server
* LDAP-JOC: manage accounts with LDAP Server, manage roles with JOC Cockpit
* OIDC: manage accounts and roles with OIDC Server
* OIDC-JOC: manage accounts with OIDC Server, manage roles with JOC Cockpit
* VAULT: manage accounts and roles with Vault Server
* VAULT-JOC: manage accounts with Vault Server, manage roles with JOC Cockpit
* VAULT-JOC-ACTIVE: manage accounts with Vault Server and JOC Cockpit, manage roles with JOC Cockpit
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Ordering
-Ordering <Int32>
Optionally specifies the position in the list of Identity Services.
| Required? | false |
| Position? | 3 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Required
-Required <SwitchParameter>
Specifies if the Identity Service is required. For any required Identity Services users have to perform a login.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Disabled
-Disabled <SwitchParameter>
The Identity Service is disabled, i.e. it is not used for authentication of user accounts.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SecondFactor
-SecondFactor <SwitchParameter>
Specifies that the Identity Service is used as a second factor in MFA.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuthenticationScheme
-AuthenticationScheme <String>
* Optionally specifies the authentication scheme which is one of
* SINGLE-FACTOR: Certificate or Password can be used for authentication.
* TWO-FACTOR: Certificate and Password have to be used for authentication.
| Required? | false |
| Position? | 4 |
| Default value | SINGLE-FACTOR |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SingleFactorCertificate
-SingleFactorCertificate <SwitchParameter>
iF single-factor authentication is used then this switch specifies if certificates are accepted as a single factor.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SingleFactorPassword
-SingleFactorPassword <SwitchParameter>
iF single-factor authentication is used then this switch specifies if passwords are accepted as a single factor.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SecondFactorService
-SecondFactorService <String>
If the -AuzthenticationScheme parameter is used with the TWO-FACTOR value, then the argument
specifies the name of the Identity Service that is used as a second factor.
| Required? | false |
| Position? | 5 |
| 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 argument is not mandatory, however, JOC Cockpit can be configured
to enforce Audit Log comments for any interventions.
| Required? | false |
| Position? | 6 |
| 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? | 7 |
| 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? | 8 |
| 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 > $service = Set-JS7IAMService -Service 'JOC' -Type 'JOC' -SingleFactorPassword
Stores the Identity Service to JOC Cockpit for use with passwords as a single factor.
-------------------------- EXAMPLE 2 --------------------------
PS > $service = Set-JS7IAMService -Service 'Certficate' -Type CERTIFICATE -SingleFactorCertificate -SecondFactor
Stores the Identity Service for use with certificates as a second factor in MFA.
-------------------------- EXAMPLE 3 --------------------------
PS > $service = Set-JS7IAMService -Service 'Multi-Factor' -Type JOC -AuthenticationScheme 'TWO-FACTOR' -SecondFactorService 'Certificate'
Stores the Identity Service for MFA using a password and a certificate from the 'Certificate' Identity Service.
Overview
Content Tools