Get-PAAccount

NAME Get-PAAccount



SYNOPSIS

Get ACME account details.





SYNTAX

Get-PAAccount [[-ID] <String>] [-Refresh] [-ExtraParams <Object>] [<CommonParameters>]



Get-PAAccount -List [-Status <String>] [-Contact <String[]>] [-KeyLength <String[]>] [-Refresh] [-ExtraParams

<Object>] [<CommonParameters>]





DESCRIPTION

Returns details such as Email, key length, and status for one or more ACME accounts previously created.





PARAMETERS

-ID <String>

The account id value as returned by the ACME server.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-List [<SwitchParameter>]

If specified, the details for all accounts will be returned.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Status <String>

A Status string to filter the list of accounts with.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Contact <String[]>

One or more email addresses to filter the list of accounts with. Returned accounts must match exactly (not

including the order).



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-KeyLength <String[]>

The type and size of private key to filter the list of accounts with. For RSA keys, specify a number between

2048-4096 (divisible by 128). For ECC keys, specify either 'ec-256' or 'ec-384'.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Refresh [<SwitchParameter>]

If specified, any account details returned will be freshly queried from the ACME server (excluding deactivated

accounts). Otherwise, cached details will be returned.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ExtraParams <Object>

This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this

function supports.



Required? false

Position? named

Default value

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

PoshACME.PAAccount





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



PS C:\\>Get-PAAccount



Get cached ACME account details for the currently selected account.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-PAAccount -ID 1234567



Get cached ACME account details for the specified account ID.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-PAAccount -List



Get all cached ACME account details.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-PAAccount -Refresh



Get fresh ACME account details for the currently selected account.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-PAAccount -List -Refresh



Get fresh ACME account details for all accounts.









-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Get-PAAccount -List -Contact user1@example.com



Get cached ACME account details for all accounts that have user1@example.com as the only contact.











RELATED LINKS

Project: https://github.com/rmbolger/Posh-ACME

Set-PAAccount

New-PAAccount