UnauthorizedException Class

Definition

Namespace

Cuemon.AspNetCore.Http

Assemblies

Cuemon.AspNetCore.dll

Source

src/Cuemon.AspNetCore/Http/UnauthorizedException.cs

The exception that is thrown when the requirements of an HTTP WWW-Authenticate header is not meet.

public class UnauthorizedException : HttpStatusCodeException, ISerializable

Inheritance

object

Exception

HttpStatusCodeException

UnauthorizedException

Implements

ISerializable

Inherited Members

HttpStatusCodeException.TryParse(int, out HttpStatusCodeException)

HttpStatusCodeException.TryParse(int, string, out HttpStatusCodeException)

HttpStatusCodeException.TryParse(int, string, Exception, out HttpStatusCodeException)

HttpStatusCodeException.Headers

HttpStatusCodeException.StatusCode

HttpStatusCodeException.ReasonPhrase

HttpStatusCodeException.ToString()

Exception.GetBaseException()

Exception.GetType()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

Examples

The following example demonstrates how to use UnauthorizedException to indicate missing or invalid authentication.

using System;

namespace Cuemon.AspNetCore.Http;

public static class UnauthorizedExceptionExample
{
    public static void Demonstrate()
    {
        const string authenticationScheme = "Bearer";
        var exception = new UnauthorizedException(
            $"The request is missing a valid {authenticationScheme} token.",
            new InvalidOperationException("Token validation failed."));

        Console.WriteLine(exception.StatusCode);
        Console.WriteLine(exception.Message);
        Console.WriteLine(exception.InnerException?.Message);
    }
}

Constructors

Name	Description
UnauthorizedException()	Initializes a new instance of the UnauthorizedException class.
UnauthorizedException(Exception)	Initializes a new instance of the UnauthorizedException class.
UnauthorizedException(string, Exception)	Initializes a new instance of the UnauthorizedException class.

See Also

HttpStatusCodeException