@craftercms/studio-ui/services/auth.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import { Observable } from 'rxjs';
import { User } from '../models/User';
import { Credentials } from '../models/Credentials';
import { ApiResponse } from '../models/ApiResponse';
interface FetchSSOLogoutUrlResponse {
  logoutUrl: string;
}
/**
 * @deprecated Please note API deprecation for Crafter v4.0.0+
 **/
export declare function fetchSSOLogoutURL(): Observable<FetchSSOLogoutUrlResponse>;
export declare function login(credentials: Credentials): Observable<boolean>;
export declare function sendPasswordRecovery(username: string): Observable<ApiResponse>;
export declare function setPassword(token: string, password: string, confirmation?: string): Observable<User>;
export declare function validatePasswordResetToken(token: string): Observable<boolean>;
export type ObtainAuthTokenResponse = {
  expiresAt: number;
  token: string;
};
export declare function obtainAuthToken(): Observable<ObtainAuthTokenResponse>;
export type FetchAuthTypeResponse = 'db' | 'ldap' | 'auth_headers' | 'saml';
export declare function fetchAuthenticationType(): Observable<FetchAuthTypeResponse>;
export {};