@azure/functions-authentication-events 1.0.0-beta.2 → 1.0.0-beta.3

package/types/latest/functions-authentication-events.d.ts

@@ -1,224 +0,0 @@
-/**
- * An interface for any responses that implement an cloud event payload and has actions on it.
- */
-export declare interface ActionableCloudEventResponse<TEventAction extends AuthenticationEventAction> extends ActionableResponse<TEventAction> {
-    /** Gets the Cloud Event \@odata.type. */
-    oDataType: string;
-}
-
-/**
- * An interface that binds a response that has actions
- */
-export declare interface ActionableResponse<TEventAction extends AuthenticationEventAction> extends AuthenticationEventResponse {
-    /** Collections of actions pertaining to the event. */
-    actions: TEventAction[];
-}
-
-/**
- * An interface representing an action for an event.
- */
-export declare interface AuthenticationEventAction {
-    /** Must be overridden, this will be the 'Name' of the action in the JSON. */
-    actionType: string;
-}
-
-/**
- * Context interface for data.
- */
-export declare interface AuthenticationEventContext {
-    /** Unique identifier for the request. */
-    correlationId: string;
-    /** The client. */
-    client: AuthenticationEventContextClient;
-    /** The authorization protocol. */
-    authenticationProtocol: "OAUTH2.0" | "SAML" | "WS-FED" | "unknownFutureValue" | undefined;
-    /** The client service principal. */
-    clientServicePrincipal: AuthenticationEventContextServicePrincipal;
-    /** The resource service principal. */
-    resourceServicePrincipal: AuthenticationEventContextServicePrincipal;
-    /** Data pertaining to the user requesting a token. */
-    user: AuthenticationEventContextUser;
-}
-
-/**
- * Client interface for data.
- */
-export declare interface AuthenticationEventContextClient {
-    /** The Ip Address */
-    ip: string;
-    /** Gets or sets the locale. */
-    locale: string;
-    /** Gets or sets the market. */
-    market: string;
-}
-
-/**
- * ResourceServicePrincipal interface for data.
- */
-export declare interface AuthenticationEventContextServicePrincipal {
-    /** The identifier for the service principal. */
-    id: string;
-    /** The application identifier. */
-    appId: string;
-    /** The application display name. */
-    appDisplayName: string;
-    /** The display name. */
-    displayName: string;
-}
-
-/**
- * User interface for data.
- */
-export declare interface AuthenticationEventContextUser {
-    /** The user's company name. */
-    companyName: string;
-    /** The user's country. */
-    country: string;
-    /** The user's display name. */
-    displayName: string;
-    /** The user's given name. */
-    givenName: string;
-    /** The user identifier. */
-    id: string;
-    /** The user's email address. */
-    mail: string;
-    /** The user's on premise SAM account name. */
-    onPremisesSamAccountName: string;
-    /** The user's on premise security identifier. */
-    onPremisesSecurityIdentifier: string;
-    /** The user's on premise principal name. */
-    onPremiseUserPrincipalName: string;
-    /** The user's preferred data location */
-    preferredDataLocation: string;
-    /** The user's preferred language. */
-    preferredLanguage: string;
-    /** The user's surname. */
-    surname: string;
-    /** The user's principal name. */
-    userPrincipalName: string;
-    /** The user type. */
-    userType: string;
-}
-
-/**
- * Event data interface pertaining to the expected payload, this interface houses the common attributes for data events.
- */
-export declare interface AuthenticationEventData {
-    /** Tenant the request is related to. */
-    tenantId: string;
-    /** Unique Id for the event. */
-    authenticationEventListenerId: string;
-    /** The unique internal Id of the registered custom extension. */
-    customAuthenticationExtensionId: string;
-}
-
-/**
- * Event request interface extended the related response and event data (payload) objects.
- */
-export declare interface AuthenticationEventRequest<TResponse extends AuthenticationEventResponse, TData extends AuthenticationEventData> extends AuthenticationEventRequestCommon {
-    /** Related IEventResponse */
-    response: TResponse;
-    /** Related IEventData */
-    payload: TData;
-}
-
-/**
- * Abstract base event interface to house common event request attributes.
- */
-export declare interface AuthenticationEventRequestCommon {
-    /** Related Type */
-    type: string;
-    /** The status of the current request, see RequestStatus. */
-    requestStatus: RequestStatus;
-    /** A user friendly message (containing errors), that the authentication event returns. */
-    statusMessage: string;
-    /** A dictionary of query string parameters */
-    queryParameters: Record<string, string>;
-}
-
-/**
- * Event response interface that houses attributes returned from the authentication events trigger.
- */
-export declare interface AuthenticationEventResponse {
-    /** A template of the body of the expected response. */
-    body: string;
-}
-
-/**
- * Event request interface extended the related response and event data (payload) objects for cloud events.
- */
-export declare interface CloudEventRequest<TResponse extends AuthenticationEventResponse, TData extends AuthenticationEventData> extends AuthenticationEventRequest<TResponse, TData> {
-    /** Related Source */
-    source: string;
-    /** Related \@odata.type */
-    oDataType: string;
-}
-
-/**
- * Helper function to create a files request
- * @param error - string or exception
- * @returns a valid FailedRequest object
- */
-export declare function createFailedRequest(error: unknown): FailedRequest;
-
-/** Helper function to create a provider claims for token */
-export declare function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken;
-
-/**
- * Return the correctly formatted error
- * */
-export declare interface FailedRequest extends AuthenticationEventResponse {
-    error: string;
-}
-
-/**
- * An Interface for the Provide Claims for token action.
- */
-export declare interface ProvideClaimsForToken extends TokenIssuanceStartAction {
-    /** The 'Name' of the action in the JSON. */
-    actionType: "microsoft.graph.ProvideClaimsForToken";
-    /** Collection of claims to add to the token. */
-    claims: TokenClaim;
-}
-
-/**
- * The status of the request.
- */
-export declare type RequestStatus = "Failed" | "TokenInvalid" | "Successful";
-
-/**
- * An type representing a claim.
- */
-export declare type TokenClaim = Record<string, string | string[]>;
-
-/**
- * All actions for the token issuance start event should extended this interface, as it looks the correct action to the correct event.
- */
-export declare interface TokenIssuanceStartAction extends AuthenticationEventAction {
-    /** This will be the 'Name' of the action in the JSON. */
-    actionType: string;
-}
-
-/**
- * The main data interface related to the request.
- */
-export declare interface TokenIssuanceStartData extends AuthenticationEventData {
-    /** The main context of the data. */
-    authenticationContext: AuthenticationEventContext;
-}
-
-/**
- * The main request interface, this will relate it's response and payload.
- */
-export declare interface TokenIssuanceStartRequest extends CloudEventRequest<TokenIssuanceStartResponse, TokenIssuanceStartData> {
-    /** A dictionary of token claims. */
-    tokenClaims?: Record<string, string>;
-}
-
-/**
- * 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.
- */
-export declare type TokenIssuanceStartResponse = ActionableCloudEventResponse<TokenIssuanceStartAction>;
-
-export { }