process::http::authentication::AuthenticationResult Struct Reference

Represents the result of authenticating a request. More...

#include <authenticator.hpp>

Public Attributes
Option< Principal >	principal
Option< Unauthorized >	unauthorized
Option< Forbidden >	forbidden

Detailed Description

Represents the result of authenticating a request.

An AuthenticationResult can represent one of the following states:

1. The request was successfully authenticated: principal is set.
2. The request was not authenticated and a new challenge is issued: unauthorized is set.
3. The request was not authenticated but no new challenge is issued: forbidden is set.

Exactly one of the member variables must be set. Setting more than one or not setting any is an error.

Member Data Documentation

Option<Forbidden> process::http::authentication::AuthenticationResult::forbidden

Option<Principal> process::http::authentication::AuthenticationResult::principal

Option<Unauthorized> process::http::authentication::AuthenticationResult::unauthorized

---

The documentation for this struct was generated from the following file:

• 3rdparty/libprocess/include/process/authenticator.hpp