New-OTSSharedSecret
SYNOPSIS
Store and share a secret value
SYNTAX
New-OTSSharedSecret [-Secret] <String> [-Passphrase] <String> [[-Ttl] <String>] [[-Recipient] <String>]
[-WhatIf] [-Confirm]
DESCRIPTION
Store and share a secret value
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
New-OTSSharedSecret -Secret "Very Secret" -Passphrase 12334
-------------------------- EXAMPLE 2 --------------------------
New-OTSSharedSecret -Secret "Very Secret" -Passphrase 1234 -Ttl 90000 -Recipient user@mail.com
PARAMETERS
-Secret
The secret value which is encrypted before being stored. There is a maximum length based on your plan that is enforced (1k-10k
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Passphrase
A string that the recipient must know to view the secret. This value is also used to encrypt the secret and is bcrypted before being stored so we only have this value in transit.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Ttl
The maximum amount of time, in seconds, that the secret should survive (i.e. time-to-live). Once this time expires, the secret will be deleted and not recoverable.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Recipient
An email address. We will send a friendly email containing the secret link (NOT the secret itself).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False