Class JsonWebSignature (1.68.0)

public class JsonWebSignature

JSON Web Signature (JWS) implementation as specified in http://tools.ietf.org/html/draft-ietf-jose-json-web-signature-11.

Inheritance

object > JsonWebSignature

Namespace

Google.Apis.Auth

Assembly

Google.Apis.Auth.dll

Methods

VerifySignedTokenAsync(string, SignedTokenVerificationOptions, CancellationToken)

public static Task<JsonWebSignature.Payload> VerifySignedTokenAsync(string signedJwt, SignedTokenVerificationOptions options = null, CancellationToken cancellationToken = default)

Verifies that the given token is a valid, not expired, signed token.

Parameters
Name Description
signedJwt string

The token to verify.

options SignedTokenVerificationOptions

The options to use for verification. May be null in which case default options will be used.

cancellationToken CancellationToken

The cancellation token for the operation.

Returns
Type Description
TaskJsonWebSignaturePayload

The payload contained by the token.

Exceptions
Type Description
InvalidJwtException

If the token is invalid or expired.

VerifySignedTokenAsync<TPayload>(string, SignedTokenVerificationOptions, CancellationToken)

public static Task<TPayload> VerifySignedTokenAsync<TPayload>(string signedJwt, SignedTokenVerificationOptions options = null, CancellationToken cancellationToken = default) where TPayload : JsonWebSignature.Payload

Verifies that the given token is a valid, not expired, signed token.

Parameters
Name Description
signedJwt string

The token to verify.

options SignedTokenVerificationOptions

The options to use for verification. May be null in which case default options will be used.

cancellationToken CancellationToken

The cancellation token for the operation.

Returns
Type Description
Task

The payload contained by the token.

Type Parameter
Name Description
TPayload

The type of the payload to return, so user code can validate additional claims. Should extend JsonWebSignature.Payload. Payload information will be deserialized using Instance.

Exceptions
Type Description
InvalidJwtException

If the token is invalid or expired.

Extension Method