ConvertFrom-HtmlJsonWebToken

August 3, 2026 ยท View on GitHub

SYNOPSIS

Decodes an OAuth or OpenID Connect JSON Web Token into a safe metadata summary.

SYNTAX

Token (Default)

ConvertFrom-HtmlJsonWebToken [-Token] <Object> [-FieldName <string>] [-IncludeJson] [-IncludeSensitiveValues] [<CommonParameters>]

Handoff

ConvertFrom-HtmlJsonWebToken [-Handoff] <Object> [-FieldName <string>] [-IncludeJson] [-IncludeSensitiveValues] [<CommonParameters>]

DESCRIPTION

Decodes an OAuth or OpenID Connect JSON Web Token into a safe metadata summary.

EXAMPLES

EXAMPLE 1

Get-HtmlBrowserSsoHandoff -Session $session -IncludeSensitiveValues | ConvertFrom-HtmlJsonWebToken

PARAMETERS

-FieldName

Specific handoff field name to inspect. Defaults to id_token and then access_token.

Type: String
Parameter Sets: Token, Handoff
Aliases: None
Possible values:

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

-Handoff

SSO handoff object returned by Get-HtmlBrowserSsoHandoff.

Type: Object
Parameter Sets: Handoff
Aliases: None
Possible values:

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

-IncludeJson

Include decoded header and payload JSON. Payload values remain redacted unless IncludeSensitiveValues is also set.

Type: SwitchParameter
Parameter Sets: Token, Handoff
Aliases: None
Possible values:

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

-IncludeSensitiveValues

Reveal subject and user-identifying claim values. Use only for authorized troubleshooting.

Type: SwitchParameter
Parameter Sets: Token, Handoff
Aliases: None
Possible values:

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

-Token

Raw compact JSON Web Token value.

Type: Object
Parameter Sets: Token
Aliases: Jwt, JsonWebToken
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue, ByPropertyName)
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.Object

OUTPUTS

  • HtmlTinkerX.HtmlJsonWebTokenSummary
  • None