#include <endpoint.h>

Inherited by ccf::endpoints::Endpoint, and ccf::js::JSDynamicEndpoint.

Public Member Functions
virtual	~EndpointDefinition ()=default

Public Attributes
EndpointKey	dispatch

URI	full_uri_path
	Full URI path to endpoint, including method prefix.

EndpointProperties	properties

AuthnPolicies	authn_policies

Constructor & Destructor Documentation

◆ ~EndpointDefinition()

virtual ccf::endpoints::EndpointDefinition::~EndpointDefinition ( )

virtualdefault

Member Data Documentation

◆ authn_policies

AuthnPolicies ccf::endpoints::EndpointDefinition::authn_policies

List of authentication policies which will be checked before executing this endpoint.

When multiple policies are specified, any single successful check is sufficient to grant access, even if others fail. If all policies fail, the last will set an error status on the response, and the endpoint will not be invoked. If no policies are specified then the default behaviour is that the endpoint accepts all requests, without any authentication checks.

If an auth policy passes, it may construct an object describing the Identity of the caller to be used by the endpoint. This can be retrieved inside the endpoint with ctx.get_caller<IdentType>(),

See also: ccf::UserCertAuthnIdentity; ccf::MemberCertAuthnIdentity; ccf::UserCOSESign1tAuthnIdentity; ccf::MemberCOSESign1AuthnIdentity; ccf::JwtAuthnIdentity; ccf::empty_auth_policy; ccf::user_cert_auth_policy; ccf::any_cert_auth_policy

◆ dispatch

EndpointKey ccf::endpoints::EndpointDefinition::dispatch

◆ full_uri_path

URI ccf::endpoints::EndpointDefinition::full_uri_path

Full URI path to endpoint, including method prefix.

◆ properties

EndpointProperties ccf::endpoints::EndpointDefinition::properties

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

include/ccf/endpoint.h

Public Member Functions