Get-EmpirePermanentToken

NAME Get-EmpirePermanentToken



SYNOPSIS

Get a permanent API token for the Empire server.





SYNTAX

Get-EmpirePermanentToken [-Id] <Int32> [-NoSSLCheck] [-UpdateSession] [<CommonParameters>]



Get-EmpirePermanentToken [-Token] <String> [-ComputerName] <String> [[-Port] <Int32>] [-NoSSLCheck]

[<CommonParameters>]





DESCRIPTION

Get a permanent API token for the Empire server.





PARAMETERS

-Id <Int32>

Empire session Id of the session to use.



Required? true

Position? 1

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Token <String>

Empire API token to use to execute the action.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ComputerName <String>

IP Address or FQDN of remote Empire server.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Port <Int32>

Port number to use in the connection to the remote Empire server.



Required? false

Position? 3

Default value 1337

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-NoSSLCheck [<SwitchParameter>]

Do not check if the TLS/SSL certificate of the Empire is valid.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UpdateSession [<SwitchParameter>]

Update the current session with the permanent token received from the server.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Empire.Token





NOTES





Licensed under BSD 3-Clause license



-------------------------- EXAMPLE 1 --------------------------



C:\\PS>Get-EmpirePermanentToken -Id 0 -UpdateSession



Get an permanent token and update the session used.











RELATED LINKS