Skip to content

Get-KeyAuthorization

Synopsis

Calculate a key authorization string for a challenge token.

Syntax

Get-KeyAuthorization [-Token] <String> [[-Account] <Object>] [-ForDNS] [<CommonParameters>]

Description

A key authorization is a string that expresses a domain holder's authorization for a specified key to satisfy a specified challenge, by concatenating the token for the challenge with a key fingerprint.

Examples

Example 1: Specific Key Auth

Get-KeyAuthorization 'XxXxXxXxXxXx'

Get the key authorization for the specified token using the current account.

Example 2: DNS Key Auths for current order

(Get-PAOrder | Get-PAAuthorization).DNS01Token | Get-KeyAuthorization -ForDNS

Get all key authorizations for the DNS challenges in the current order using the current account.

Parameters

-Token

The token string for an ACME challenge.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Account

The ACME account associated with the challenge.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForDNS

Enable this switch if you're using the key authorization value for the 'dns-01' challenge type. It will do a few additional manipulation steps on the value that are required for a DNS TXT record.

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

System.String

The token value from an ACME challenge object.

Outputs

System.String

The key authorization value.

Get-PAAuthorization

Submit-ChallengeValidation