Class ApiKeyException

Namespace

Cuemon.AspNetCore.Http.Headers

Assembly

Cuemon.AspNetCore.dll

The exception that is thrown when the requirements of an API key header is not meet.

public class ApiKeyException : HttpStatusCodeException, ISerializable

Inheritance

object

Exception

HttpStatusCodeException

ApiKeyException

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 a is used to signal that a request's API key header validation failed.

using System;
using Microsoft.AspNetCore.Http;

        namespace Cuemon.AspNetCore.Http.Headers;

        public static class ApiKeyExceptionExample
        {
            public static void Demonstrate()
            {
                var exception = new ApiKeyException(StatusCodes.Status403Forbidden, "The API key was rejected.");
        Console.WriteLine($"{exception.StatusCode} {exception.ReasonPhrase}");
            }
        }

Constructors

ApiKeyException(int, string)

Initializes a new instance of the ApiKeyException class.

public ApiKeyException(int statusCode, string message)

Parameters

statusCode int

The HTTP status code to associate with this exception.

message string

The message that describes the HTTP status code.

See Also

HttpStatusCodeException