@alwaysai/cloud-api
Version:
A library for defining the alwaysAI Cloud API
49 lines • 2.08 kB
TypeScript
import { SystemId } from './constants';
export declare type AuthenticationStorage = {
setItem(key: string, value: string): void;
getItem(key: string): string;
removeItem(key: string): void;
clear(): void;
};
export declare const AuthenticationState: {
AUTHENTICATED: "AUTHENTICATED";
USER_CONFIRMATION_REQUIRED: "USER_CONFIRMATION_REQUIRED";
PASSWORD_RESET_REQUIRED: "PASSWORD_RESET_REQUIRED";
INCORRECT_PASSWORD: "INCORRECT_PASSWORD";
USER_NOT_FOUND: "USER_NOT_FOUND";
NON_TEMPORARY_PASSWORD_REQUIRED: "NON_TEMPORARY_PASSWORD_REQUIRED";
INVALID_PASSWORD: "INVALID_PASSWORD";
MFA_REQUIRED: "MFA_REQUIRED";
TOTP_REQUIRED: "TOTP_REQUIRED";
MFA_SETUP: "MFA_SETUP";
SELECT_MFA_TYPE: "SELECT_MFA_TYPE";
CUSTOM_CHALLENGE: "CUSTOM_CHALLENGE";
};
export declare function AuthenticationClient(config: {
systemId: SystemId;
storage: AuthenticationStorage;
readonly?: boolean;
}): {
isSignedIn(): boolean;
signOut(): void;
getAuthorizationHeader(): Promise<{
Authorization: string;
}>;
getIdAuthorizationHeader(): Promise<{
Authorization: string;
}>;
getInfo(): Promise<{
username: string;
uuid: string;
email: string;
}>;
signIn(email: string, password: string): Promise<{
authenticationState: "NON_TEMPORARY_PASSWORD_REQUIRED";
setNonTemporaryPassword(password: string): Promise<{
authenticationState: "CUSTOM_CHALLENGE" | "MFA_SETUP" | "SELECT_MFA_TYPE" | "AUTHENTICATED" | "USER_CONFIRMATION_REQUIRED" | "PASSWORD_RESET_REQUIRED" | "INCORRECT_PASSWORD" | "USER_NOT_FOUND" | "NON_TEMPORARY_PASSWORD_REQUIRED" | "INVALID_PASSWORD" | "MFA_REQUIRED" | "TOTP_REQUIRED";
}>;
} | {
authenticationState: "CUSTOM_CHALLENGE" | "MFA_SETUP" | "SELECT_MFA_TYPE" | "AUTHENTICATED" | "USER_CONFIRMATION_REQUIRED" | "PASSWORD_RESET_REQUIRED" | "INCORRECT_PASSWORD" | "USER_NOT_FOUND" | "INVALID_PASSWORD" | "MFA_REQUIRED" | "TOTP_REQUIRED";
}>;
};
//# sourceMappingURL=authentication-client.d.ts.map