unauthorized
mach::unauthorized
Creates an Unauthorized response.
Description
Section titled “Description”Creates a 401 Unauthorized response, optionally containing the specified value.
Syntax
Section titled “Syntax”// (1)template <typename T>[[nodiscard]] mach::Reply<T> unauthorized(T value);
// (2)[[nodiscard]] mach::Reply<std::string> unauthorized(const char* value);
// (3)template <typename T = void>[[nodiscard]] mach::Reply<T> unauthorized();Return Value
Section titled “Return Value”Overload (1)
Section titled “Overload (1)”An Unauthorized reply containing the specified value.
Overload (2)
Section titled “Overload (2)”An Unauthorized reply containing the specified string.
Overload (3)
Section titled “Overload (3)”An Unauthorized reply with no value.
Template Parameters
Section titled “Template Parameters”Overload (1)
Section titled “Overload (1)”| Parameter | Description |
|---|---|
T |
The type of the response body. |
Overload (3)
Section titled “Overload (3)”| Parameter | Description |
|---|---|
T |
The reply value type used to match the endpoint’s return type. Defaults to void. |
Parameters
Section titled “Parameters”Overload (1)
Section titled “Overload (1)”| Parameter | Description |
|---|---|
value |
The response body. |
Overload (2)
Section titled “Overload (2)”| Parameter | Description |
|---|---|
value |
The response body. |
Remarks
Section titled “Remarks”Overload (2) converts the specified value to a std::string.
Examples
Section titled “Examples”Overload (1)
Section titled “Overload (1)”return mach::unauthorized(error);Overload (2)
Section titled “Overload (2)”return mach::unauthorized("Authentication required.");Overload (3)
Section titled “Overload (3)”return mach::unauthorized();See Also
Section titled “See Also”| Name | Description |
|---|---|
Reply |
Represents the result of an HTTP endpoint. |
ControllerBase::unauthorized |
Creates an Unauthorized response from a controller. |