Get-RocketCyberAPIKey

SYNOPSIS

Gets the RocketCyber API bearer token global variable.

SYNTAX

Get-RocketCyberAPIKey [-plainText] [<CommonParameters>]

DESCRIPTION

The Get-RocketCyberAPIKey cmdlet gets the RocketCyber API bearer token global variable and returns it as a SecureString.

EXAMPLES

EXAMPLE 1

Get-RocketCyberAPIKey

Gets the RocketCyber API bearer token global variable and returns it as a SecureString.

EXAMPLE 2

Get-RocketCyberAPIKey -PlainText

Gets and decrypts the API key from the global variable and returns the API key in plain text

PARAMETERS

-plainText

Decrypt and return the API key in plain text.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

N\A

RELATED LINKS

https://celerium.github.io/RocketCyber-PowerShellWrapper/site/Internal/Get-RocketCyberAPIKey.html