Creates a new OATH token object.
New-SystoLockOathToken [[-Algorithm] <String>] [[-Digits] <Int32>] [[-Identifier] <String>] [[-Secret] <Secret>]
[[-TimeStep] <Int32>] [-Address <ServiceAddress>] [-AuthType <NtdsAuthType>] [-DomainController <String>]
[-Timeout <Int32>] [<CommonParameters>]
New-SystoLockOathToken [[-Digits] <Int32>] [-Hotp] [[-Identifier] <String>] [[-Secret] <Secret>]
[-Address <ServiceAddress>] [-AuthType <NtdsAuthType>] [-DomainController <String>] [-Timeout <Int32>]
[<CommonParameters>]
New-SystoLockOathToken [-Ecdh] [[-Identifier] <String>] [-Address <ServiceAddress>] [-AuthType <NtdsAuthType>]
[-DomainController <String>] [-Timeout <Int32>] [<CommonParameters>]
New-SystoLockOathToken [-Token] <OathToken> [-Address <ServiceAddress>] [-AuthType <NtdsAuthType>]
[-DomainController <String>] [-Timeout <Int32>] [<CommonParameters>]
New-SystoLockOathToken -Url <String> [-Address <ServiceAddress>] [-AuthType <NtdsAuthType>] [-DomainController <String>]
[-Timeout <Int32>] [<CommonParameters>]
The New-SystoLockOathToken cmdlet creates a new TOTP, HOTP or ECDH OATH token object in the server token store.
All cmdlets interacting with SystoLOCK service have -Address and -Timeout parameters to adjust their behavior.
You can also set $SystoLockAddress and $SystoLockTimeout PowerShell variables or $SystoLockAddress and $SystoLockTimeout environment variables which let you specify these parameters as defaults.
If no parameters or environment variables are specified, the timeout defaults to 3 seconds and the address is obtained from DNS for current domain and site.
New-SystoLockOathToken
Creates a new TOTP SHA256 token.
New-SystoLockOathToken -Hotp
Creates a new HOTP SHA1 token.
New-SystoLockOathToken -Ecdh
Creates a new ECDH token.
New-SystoLockOathToken -Secret BXIIUQEDJ4DMCHKPVA4FNNZO4KEX5726 -Digits 8 -Algorithm SHA512 -TimeStep 20
Creates an new TOTP token using custom parameters.
New-SystoLockOathToken -Identifier GAKT000168DE -Secret BXIIUQEDJ4DMCHKPVA4FNNZO4KEX5726 -Digits 8 -Hotp
Creates an HOTP token using specified name and custom parameters.
New-SystoLockOathToken -Identifier YSC148151623 -Ecdh
Creates an ECDH token using specified name.
New-SystoLockOathToken -Url 'otpauth://totp/Example:alice@google.com?secret=CXIIUQEDJ4DMCHKPVA4FNNZO4KEX5726&issuer=Example&algorithm=SHA256&digits=6&period=30'
Creates a new OATH token from an 'otpauth:' URI.
Specifies service address (optional).
Accepts an URL, a host name or a Service structure returned by previous Get-SystoLockService call.
Type: ServiceAddress
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies cryptographic algorithm (can be: SHA1, SHA256 or SHA512).
Dynamic parameter, used only if -Hotp parameter is false.
Type: String
Parameter Sets: Algorithm
Aliases:
Accepted values: SHA1, SHA256, SHA512
Required: False
Position: 3
Default value: SHA256
Accept pipeline input: False
Accept wildcard characters: False
Specifies authentication method to use with domain controller (optional).
The acceptable values for this parameter are: Kerberos and Negotiate.
The default method is Kerberos.
Possible values: Kerberos, Negotiate
Type: NtdsAuthType
Parameter Sets: (All)
Aliases:
Accepted values: Kerberos, Negotiate
Required: False
Position: Named
Default value: Kerberos
Accept pipeline input: False
Accept wildcard characters: False
Specifies password digit count (range: 6 - 10, default: 6).
Type: Int32
Parameter Sets: Algorithm, Hotp
Aliases:
Required: False
Position: 2
Default value: 6
Accept pipeline input: False
Accept wildcard characters: False
Specifies domain controller name (optional).
Accepts a domain name, a fully qualified domain name or an IP address of the domain controller.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies ECDH token creation parameter.
Type: SwitchParameter
Parameter Sets: Ecdh
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies HOTP token creation (no parameter: TOTP token creation).
Type: SwitchParameter
Parameter Sets: Hotp
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies token identifier (optional).
Type: String
Parameter Sets: Algorithm, Hotp, Ecdh
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies secret value (optional).
Accepts a byte array, hex-, base32- or base64-encoded string there.
To define the string encoding exactly you can use 'HEX:...', 'B32:...', 'B64:...', 'BASE32:...' or 'BASE64:...' prefix.
Type: Secret
Parameter Sets: Algorithm, Hotp
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies time increment (range: 10 - 120 seconds, default: 30 seconds).
Dynamic parameter, used only if -Hotp parameter is false.
Type: Int32
Parameter Sets: Algorithm
Aliases:
Required: False
Position: 4
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False
Specifies timeout (range: 1 - 30 seconds, default: 3 seconds).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies OathToken structure returned by previous Get-SystoLockOathToken call and modified then.
Type: OathToken
Parameter Sets: Token
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies URL representing the token description.
Type: String
Parameter Sets: Url
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Specifies OathToken structure returned by previous Get-SystoLockOathToken call and modified then.
Specifies URL representing the token description.
Represents OTP token information.
Algorithm: OTP algorithm identifier.
Class: OATH token class.
Constraints: OTP token constraints if any applied.
NotAfter: usage end date of the token.
NotBefore: usage start date of the token.
NumberOfTransactions: maximum number of times the token can be used.
FriendlyName: token friendly name.
Identifier: token unique identifier.
Interval: time interval value for time-based OTP algorithms in seconds.
Manufacturer: token manufacturer name.
Model: token model name.
ResponseLength: length of a one-time password.
RuntimeContext: OTP token runtime context.
DisableTime: value indicating whether and when the token was disabled.
Drift: value indicating token drift for time-based OTP algorithms.
Failures: time of last failed authentication.
LastTimeUsed: value indicating the token was last time used.
LockTime: value indicating whether and when the token was locked.
PerformedTransactions: value indicating the number of successfully performed transactions.
User: identifier of a user this token is assigned to.
Secret: token secret value.
IssueNumber: token issue number.
You can redistribute a created token in QR Code format.
See ConvertTo-SystoLockQRCode cmdlet manual for more information.