@azure/functions-authentication-events package

Interfaces

ActionableCloudEventResponse	An interface for any responses that implement an cloud event payload and has actions on it.
ActionableResponse	An interface that binds a response that has actions
AuthenticationEventAction	An interface representing an action for an event.
AuthenticationEventContext	Context interface for data.
AuthenticationEventContextClient	Client interface for data.
AuthenticationEventContextServicePrincipal	ResourceServicePrincipal interface for data.
AuthenticationEventContextUser	User interface for data.
AuthenticationEventData	Event data interface pertaining to the expected payload, this interface houses the common attributes for data events.
AuthenticationEventRequest	Event request interface extended the related response and event data (payload) objects.
AuthenticationEventRequestCommon	Abstract base event interface to house common event request attributes.
AuthenticationEventResponse	Event response interface that houses attributes returned from the authentication events trigger.
CloudEventRequest	Event request interface extended the related response and event data (payload) objects for cloud events.
FailedRequest	Return the correctly formatted error
ProvideClaimsForToken	An Interface for the Provide Claims for token action.
TokenIssuanceStartAction	All actions for the token issuance start event should extended this interface, as it looks the correct action to the correct event.
TokenIssuanceStartData	The main data interface related to the request.
TokenIssuanceStartRequest	The main request interface, this will relate it's response and payload.

Type Aliases

RequestStatus	The status of the request.
TokenClaim	An type representing a claim.
TokenIssuanceStartResponse	The main response interface that is related to the request, this extends IActionable as the response contains actions, we only allow actions that inherit the TokenIssuanceStartAction.

Functions

createFailedRequest(unknown)	Helper function to create a files request
createProvideClaimsForToken(TokenClaim)	Helper function to create a provider claims for token

Function Details

createFailedRequest(unknown)

Helper function to create a files request

function createFailedRequest(error: unknown): FailedRequest

Parameters

error

unknown

string or exception

Returns

FailedRequest

a valid FailedRequest object

createProvideClaimsForToken(TokenClaim)

Helper function to create a provider claims for token

function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken

Parameters

claims

TokenClaim

Returns

ProvideClaimsForToken