cidaas-javascript-sdk 4.3.2 → 5.0.0

package/dist/web-auth/WebAuth.d.ts

@@ -1,665 +0,0 @@
-import { GetAccessTokenRequest, RenewTokenRequest, TokenIntrospectionRequest } from '../token-service/TokenService.model';
-import { AcceptClaimConsentRequest, AcceptConsentRequest, AcceptScopeConsentRequest, GetConsentDetailsRequest, GetConsentVersionDetailsRequest, RevokeClaimConsentRequest } from '../consent-service/ConsentService.model';
-import { FirstTimeChangePasswordRequest, LoginAfterRegisterRequest, LoginWithCredentialsRequest, MfaContinueRequest, PasswordlessLoginRequest, ProgressiveRegistrationHeader, SocialProviderPathParameter, SocialProviderQueryParameter } from '../login-service/LoginService.model';
-import { LoginPrecheckRequest } from '../common/Common.model';
-import { CidaasUser } from '../common/User.model';
-import { ChangePasswordRequest, CompleteLinkAccountRequest, DeduplicationLoginRequest, DeleteUserAccountRequest, GetDeduplicationDetailsRequest, GetInviteUserDetailsRequest, GetUserProfileRequest, HandleResetPasswordRequest, InitiateLinkAccountRequest, InitiateResetPasswordRequest, RegisterDeduplicationRequest, RegisterRequest, ResetPasswordRequest, UserCheckExistsRequest, getCommunicationStatusRequest } from '../user-service/UserService.model';
-import { HTTPRequestHeader } from "../common/Common.model";
-import { User } from "oidc-client-ts";
-import { OidcSettings, LoginRedirectOptions, PopupSignInOptions, SilentSignInOptions, LogoutRedirectOptions, PopupSignOutOptions, LogoutResponse, LoginRequestOptions } from "../authentication/Authentication.model";
-import { AuthenticateMFARequest, CancelMFARequest, CheckVerificationTypeConfiguredRequest, ConfigureFriendlyNameRequest, ConfigureVerificationRequest, EnrollVerificationRequest, GetMFAListRequest, InitiateAccountVerificationRequest, InitiateEnrollmentRequest, InitiateMFARequest, InitiateVerificationRequest, VerifyAccountRequest } from "../verification-service/VerificationService.model";
-import { DeleteDeviceRequest, GetClientInfoRequest, GetRegistrationSetupRequest, GetUserActivitiesRequest, LogoutUserRequest, UpdateProfileImageRequest, UserActionOnEnrollmentRequest, GetRequestIdRequest } from "./webauth.model";
-export declare const createPreloginWebauth: (authority: string) => WebAuth;
-export declare class WebAuth {
-    constructor(settings: OidcSettings);
-    /**
-     * Generate and redirect to authz url in same window for logging in.
-     * @param {LoginRedirectOptions} options options options to over-ride the client config for redirect login
-     */
-    loginWithBrowser(options?: LoginRedirectOptions): Promise<void>;
-    /**
-     * Generate and open authz url in a popup window.
-     * On successful sign in, authenticated user is returned.
-     *
-     * @param {PopupSignInOptions} options options to over-ride the client config for popup sign in
-     * @returns {Promise<User>} Authenticated user
-     * @throws error if unable to get the parse and get user
-     */
-    popupSignIn(options?: PopupSignInOptions): Promise<User>;
-    /**
-     * Generate and navigate to authz url in an iFrame.
-     * On successful sign in, authenticated user is returned
-     *
-     * @param {SilentSignInOptions} options options to over-ride the client config for silent sign in
-     * @returns {Promise<User>} Authenticated user
-     * @throws error if unable to get the parse and get user
-     */
-    silentSignIn(options?: SilentSignInOptions): Promise<User>;
-    /**
-     * Generate and redirect to authz url in same window for register view.
-     * @param {LoginRedirectOptions} options options options to over-ride the client config for redirect login
-     */
-    registerWithBrowser(options?: LoginRedirectOptions): Promise<void>;
-    /**
-     * Once login successful, it will automatically redirects you to the redirect url whatever you mentioned in the options.
-     * To complete the login process, call **loginCallback()**. This will parses the access_token, id_token and whatever in hash in the redirect url.
-     *
-     * @param {string} url optional url from where to process the login state
-     * @returns {Promise<User>} Authenticated user
-     * @throws error if unable to get the parse and get user
-     */
-    loginCallback(url?: string): Promise<User>;
-    /**
-     * To complete the popup login process, call **popupSignInCallback()** from the popup login window.
-     * Popup window will be closed after doing callback
-     *
-     * @param {string} url optional url to read sign-in callback state from
-     * @param {boolean} keepOpen true to keep the popup open even after sign in, else false
-     */
-    popupSignInCallback(url?: string, keepOpen?: boolean): Promise<void>;
-    /**
-     * Returns a promise to notify the parent window of response from authz service
-     * @param {string} url optional url to check authz response, if none window.location is used
-     */
-    silentSignInCallback(url?: string): Promise<void>;
-    /**
-     * To get the user profile information by using oidc-client-ts library, call **getUserInfo()**. This will return the basic user profile details along with groups, roles and whatever scopes you mentioned in the options.
-     * @example
-     * ```js
-     * cidaas.getUserInfo().then(function (response) {
-     *   // the response will give you profile details.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     * @return {Promise<User|null>} returns authenticated user if present, else null
-     */
-    getUserInfo(): Promise<User | null>;
-    /**
-     * logout by using oidc-client-ts library
-     * @param {LogoutRedirectOptions} options optional options to over-ride logout options on redirect
-     */
-    logout(options?: LogoutRedirectOptions): Promise<void>;
-    /**
-     * logout by using oidc-client-ts library
-     * @param {PopupSignOutOptions} options optional options to over-ride logout options using popup window
-     */
-    popupSignOut(options?: PopupSignOutOptions): Promise<void>;
-    /**
-     * get the logout call state from the url provided, if none is provided current window url is used
-     * @returns {Promise<LogoutResponse>} logout response from auth service
-     */
-    logoutCallback(url?: string): Promise<LogoutResponse>;
-    /**
-     * listen to popup sign out event
-     * @param {string} url optional url to override to check for sign out state
-     * @param {boolean} keepOpen true to keep the popup open even after sign out, else false
-     */
-    popupSignOutCallback(url?: string, keepOpen?: boolean): Promise<void>;
-    /**
-     * To get the generated login url, call **getLoginURL()**. This will call authz service and generate login url to be used.
-     * @example
-     * ```js
-     * cidaas.getLoginURL().then(function (response) {
-     *   // the response will give you login url.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     * @param {LoginRequestOptions} options login options to override {@link window.webAuthSettings} provided
-     * @return {Promise<string>} authz url for login
-     */
-    getLoginURL(options?: LoginRequestOptions): Promise<string>;
-    /**
-     * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
-     * @example
-     * ```js
-     * // To get requestId using default configured settings, run the function without parameter
-     * cidaas.getRequestId().then(function (response) {
-     *   // the response will give you request id.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     *
-     * // To get requestId using custom settings, run the function with custom setting(s) inside option parameter. Example below will only override client_id & redirect_uri
-     * const option: GetRequestIdRequest = {
-     *   'client_id': 'your client id',
-     *   'redirect_uri': 'your redirect url',
-     * }
-     * cidaas.getRequestId(option).then(function (response) {
-     *   // the response will give you request id.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     */
-    getRequestId(option?: GetRequestIdRequest): Promise<any>;
-    /**
-     * To get the tenant basic information, call **getTenantInfo()**. This will return the basic tenant details such as tenant name and allowed login with types (Email, Mobile, Username).
-     * @example
-     * ```js
-     * cidaas.getTenantInfo().then(function (response) {
-     *   // the response will give you tenant details
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     */
-    getTenantInfo(): Promise<any>;
-    /**
-     * To logout the user by using cidaas internal api, call **logoutUser()**.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3b5ce6a54bf29-logout for more details.
-     * @example
-     * ```js
-     * cidaas.logoutUser({
-     *   access_token : 'your accessToken'
-     * });
-     * ```
-     */
-    logoutUser(options: LogoutUserRequest): void;
-    /**
-     * To get the client basic information, call **getClientInfo()**. This will return the basic client details such as client name and its details.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/dc8a6cfb28abb-public-page-information for more details.
-     * @example
-     * ```js
-     * cidaas.getClientInfo({
-     *   requestId: 'your requestId',
-     * }).then(function (resp) {
-     *   // the response will give you client info.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     */
-    getClientInfo(options: GetClientInfoRequest): Promise<any>;
-    /**
-     * To get all devices information associated to the client, call **getDevicesInfo()**
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a2feed70303c-get-device-by-user for more details.
-     * @example
-     * ```js
-     * const options = null; // the payload is deprecated and will be removed in the next major release
-     * const accessToken = 'your access token';
-     * cidaas.getDevicesInfo(options, accessToken).then(function (resp) {
-     *   // the response will give you devices informations.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     */
-    getDevicesInfo(options: void, accessToken: string): Promise<any>;
-    /**
-     * To delete device associated to the client, call **deleteDevice()**
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3d44ad903d6e8-logout-the-user-for-a-device for more details.
-     * @example
-     * ```js
-     * const options = {
-     *   device_id: 'id of device associated to the client.' // call **getDevicesInfo()** to get List of device ids and its details.
-     * };
-     * const accessToken = 'your access token';
-     * cidaas.deleteDevice(options, accessToken).then(function (resp) {
-     *   // your success code
-     * }).catch(function(ex) {
-     *   // your failure code
-     * });
-     * ```
-     */
-    deleteDevice(options: DeleteDeviceRequest, accessToken: string): Promise<any>;
-    /**
-     * To handle registration, first you need the registration fields. To get the registration fields, call **getRegistrationSetup()**. This will return the fields that has to be needed while registration.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/4eae72956f65a-registration-field-setup for more details.
-     * @example
-     * ```js
-     * cidaas.getRegistrationSetup({
-     *   requestId: 'your requestId',
-     *   acceptlanguage: 'your locale' // optional example: de-de, en-US
-     * }).then(function (resp) {
-     *   // the response will give you fields that are required.
-     * }).catch(function(ex) {
-     *   // your failure code here
-     * });
-     * ```
-     */
-    getRegistrationSetup(options: GetRegistrationSetupRequest): Promise<any>;
-    /**
-     * to generate device info, call **createDeviceInfo()**.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9b5a892afaf0b-create-device-info for more details.
-     * @example
-     * ```js
-     * cidaas.createDeviceInfo().then(function (resp) {
-     *   // your success code
-     * }).catch(function(ex) {
-     *   // your failure code
-     * });
-     * ```
-     */
-    createDeviceInfo(): Promise<any>;
-    /**
-     * get the user profile information
-     * @param options
-     * @returns
-     */
-    getUserProfile(options: GetUserProfileRequest): Promise<any>;
-    /**
-     * renew token using refresh token
-     * @param options
-     * @returns
-     */
-    renewToken(options: RenewTokenRequest): Promise<any>;
-    /**
-     * get access token from code
-     * @param options
-     * @returns
-     */
-    getAccessToken(options: GetAccessTokenRequest): Promise<any>;
-    /**
-     * validate access token
-     * @param options
-     * @returns
-     */
-    validateAccessToken(options: TokenIntrospectionRequest): Promise<any>;
-    /**
-     * login with username and password
-     * @param options
-     */
-    loginWithCredentials(options: LoginWithCredentialsRequest): void;
-    /**
-     * login with social
-     * @param options
-     * @param queryParams
-     */
-    loginWithSocial(options: SocialProviderPathParameter, queryParams?: SocialProviderQueryParameter): void;
-    /**
-     * register with social
-     * @param options
-     * @param queryParams
-     */
-    registerWithSocial(options: SocialProviderPathParameter, queryParams?: SocialProviderQueryParameter): void;
-    /**
-     * register user
-     * @param options
-     * @param headers
-     * @returns
-     */
-    register(options: RegisterRequest, headers: HTTPRequestHeader): Promise<any>;
-    /**
-     * get invite info
-     * @param options
-     * @param headers
-     * @returns
-     */
-    getInviteUserDetails(options: GetInviteUserDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * get Communication status
-     * @param options
-     * @param headers
-     * @returns
-     */
-    getCommunicationStatus(options: getCommunicationStatusRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * initiate verification
-     * @param options
-     * @returns
-     */
-    initiateAccountVerification(options: InitiateAccountVerificationRequest): void;
-    /**
-     * verify account
-     * @param options
-     * @param headers
-     * @returns
-     */
-    verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * initiate reset password
-     * @param options
-     * @param headers
-     * @returns
-     */
-    initiateResetPassword(options: InitiateResetPasswordRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * handle reset password
-     * @param options
-     * @param handleResponseAsJson
-     * @param headers
-     */
-    handleResetPassword(options: HandleResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-    * reset password
-    * @param options
-    * @param handleResponseAsJson
-    * @param headers
-    */
-    resetPassword(options: ResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * get mfa list
-     * @param options
-     * @param headers
-     * @returns
-     */
-    getMFAList(options: GetMFAListRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * cancel mfa
-     * @param options
-     * @param headers
-     * @returns
-     */
-    cancelMFA(options: CancelMFARequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * passwordless login
-     * @param options
-     */
-    passwordlessLogin(options: PasswordlessLoginRequest): void;
-    /**
-     * get user consent details
-     * @param options
-     * @returns
-     */
-    getConsentDetails(options: GetConsentDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * accept consent
-     * @param options
-     * @param headers
-     * @returns
-     */
-    acceptConsent(options: AcceptConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * get scope consent details
-     * @param options
-     * @param headers
-     * @returns
-     */
-    loginPrecheck(options: LoginPrecheckRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * get scope consent version details
-     * @param options
-     * @param headers
-     * @returns
-     */
-    getConsentVersionDetails(options: GetConsentVersionDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * accept scope Consent
-     * @param options
-     * @param headers
-     * @returns
-     */
-    acceptScopeConsent(options: AcceptScopeConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * accept claim Consent
-     * @param options
-     * @param headers
-     * @returns
-     */
-    acceptClaimConsent(options: AcceptClaimConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * revoke claim Consent
-     * @param options
-     * @returns
-     */
-    revokeClaimConsent(options: RevokeClaimConsentRequest): Promise<any>;
-    /**
-     * get Deduplication details
-     * @param options
-     * @param headers
-     * @returns
-     */
-    getDeduplicationDetails(options: GetDeduplicationDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * deduplication login
-     * @param options
-     */
-    deduplicationLogin(options: DeduplicationLoginRequest): void;
-    /**
-     * register Deduplication
-     * @param options
-     * @param headers
-     * @returns
-     */
-    registerDeduplication(options: RegisterDeduplicationRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * consent continue login
-     * @param options
-     */
-    consentContinue(options: LoginPrecheckRequest): void;
-    /**
-     * mfa continue login
-     * options: PhysicalVerificationLoginRequest is not needed anymore. It is now DEPRECATED and will be removed in the next major release
-     * @param options
-     */
-    mfaContinue(options: MfaContinueRequest): void;
-    /**
-     * change password continue
-     * @param options
-     */
-    firstTimeChangePassword(options: FirstTimeChangePasswordRequest): void;
-    /**
-     * change password
-     * @param options
-     * @param access_token
-     * @returns
-     */
-    changePassword(options: ChangePasswordRequest, access_token: string): Promise<any>;
-    /**
-     * update profile
-     * @param options
-     * @param access_token
-     * @param sub
-     * @returns
-     */
-    updateProfile(options: CidaasUser, access_token: string, sub: string): Promise<any>;
-    /**
-     * To get user activities, call **getUserActivities()**.
-     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/346141453781e-get-user-activities for more details.
-     * @example
-     * ```js
-     * const options = {
-     *   sub: 'your sub',
-     *   dateFilter: {
-     *     from_date: 'date in UTC format',
-     *     to:date: 'date in UTC format'
-     *   }
-     * };
-     * const accessToken = 'your access token';
-     * cidaas.getUserActivities(options, accessToken).then(function (resp) {
-     *   // your success code
-     * }).catch(function(ex) {
-     *   // your failure code
-     * });
-     * ```
-     */
-    getUserActivities(options: GetUserActivitiesRequest, accessToken: string): Promise<any>;
-    /**
-     * To run predefined action after enrollment, call userActionOnEnrollment()
-     * @param options
-     * @param trackId
-     * @example
-     * ```js
-     * const options = {
-     *   action: 'predefined action'
-     * };
-     * cidaas.userActionOnEnrollment(options, 'trackId');
-     */
-    userActionOnEnrollment(options: UserActionOnEnrollmentRequest, trackId: string): Promise<any>;
-    /**
-     * @param access_token
-     * @param headers
-     * @returns
-     */
-    getAllVerificationList(access_token: string, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * initiate link accoount
-     * @param options
-     * @param access_token
-     * @returns
-     */
-    initiateLinkAccount(options: InitiateLinkAccountRequest, access_token: string): Promise<any>;
-    /**
-     * complete link accoount
-     * @param options
-     * @param access_token
-     * @returns
-     */
-    completeLinkAccount(options: CompleteLinkAccountRequest, access_token: string): Promise<any>;
-    /**
-     * get linked users
-     * @param access_token
-     * @param sub
-     * @returns
-     */
-    getLinkedUsers(access_token: string, sub: string): Promise<any>;
-    /**
-     * unlink accoount
-     * @param access_token
-     * @param identityId
-     * @returns
-     */
-    unlinkAccount(access_token: string, identityId: string): Promise<any>;
-    /**
-    * To change profile image, call **updateProfileImage()**.
-    * @example
-    * ```js
-    * const options = {
-    *   image_key: 'id for your image e.g. user sub',
-    *   photo: yourImageFile,
-    *   filename: 'name of your image file'
-    * };
-    * const accessToken = 'your access token';
-    * cidaas.updateProfileImage(options, accessToken).then(function (resp) {
-    *   // your success code
-    * }).catch(function(ex) {
-    *   // your failure code
-    * });
-    * ```
-    */
-    updateProfileImage(options: UpdateProfileImageRequest, access_token: string): Promise<any>;
-    /**
-     * enrollVerification
-     * @param options
-     * @returns
-     */
-    initiateEnrollment(options: InitiateEnrollmentRequest, accessToken: string): Promise<any>;
-    /**
-     * update the status of notification
-     * @param status_id
-     * @param headers
-     * @returns
-     */
-    getEnrollmentStatus(status_id: string, accessToken: string, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * enrollVerification
-     * @param options
-     * @returns
-     */
-    enrollVerification(options: EnrollVerificationRequest): Promise<any>;
-    /**
-     * checkVerificationTypeConfigured
-     * @param options
-     * @returns
-     */
-    checkVerificationTypeConfigured(options: CheckVerificationTypeConfiguredRequest): Promise<any>;
-    /**
-     * deleteUserAccount
-     * @param options
-     * @returns
-     */
-    deleteUserAccount(options: DeleteUserAccountRequest): Promise<any>;
-    /**
-     * getMissingFields
-     * @param trackId - required. If only trackId is given, it will get missing fields from cidaas after succesful registration using default provider
-     * @param useSocialProvider - optional. If given, it will get missing fields from social provider after successful registration using social provider
-     *
-     * @example
-     * ```js
-     * const trackId = 'your track id'
-     * const useSocialProvider = {
-     *   requestId: 'request id from cidaas'
-     * };
-     * cidaas.getMissingFields(trackId, useSocialProvider).then(function (resp) {
-     *   // your success code
-     * }).catch(function(ex) {
-     *   // your failure code
-     * });
-     * ```
-     *
-     */
-    getMissingFields(trackId: string, useSocialProvider?: {
-        requestId: string;
-    }, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * progressiveRegistration
-     * @param options
-     * @param headers
-     * @returns
-     */
-    progressiveRegistration(options: CidaasUser, headers: ProgressiveRegistrationHeader): Promise<any>;
-    /**
-     * loginAfterRegister
-     * @param options
-     */
-    loginAfterRegister(options: LoginAfterRegisterRequest): void;
-    /**
-     * device code flow - initiate
-     */
-    initiateDeviceCode(clientId?: string): Promise<any>;
-    /**
-     * device code flow - verify
-     * @param code
-     */
-    deviceCodeVerify(code: string): void;
-    /**
-     * check if an user exists
-     * @param options
-     * @param headers
-     * @returns
-     */
-    userCheckExists(options: UserCheckExistsRequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * To set accept language
-     * @param acceptLanguage
-     */
-    setAcceptLanguageHeader(acceptLanguage: string): void;
-    /**
-     * initiate mfa
-     * @param options
-     * @param headers
-     * @returns
-     */
-    initiateMFA(options: InitiateMFARequest, accessToken?: string, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * authenticate mfa
-     * @param options
-     * @param headers
-     * @returns
-     */
-    authenticateMFA(options: AuthenticateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
-    /**
-     * initiate verification
-     * @param options
-     * @returns
-     */
-    initiateVerification(options: InitiateVerificationRequest, trackId: string, method: string): Promise<any>;
-    /**
-     * configure verification
-     * @param options
-     * @returns
-     */
-    configureVerification(options: ConfigureVerificationRequest, method: string): Promise<any>;
-    /**
-     * configure friendly name
-     * @param options
-     * @returns
-     */
-    configureFriendlyName(options: ConfigureFriendlyNameRequest, trackId: string, method: string): Promise<any>;
-    /**
-     * login as guest
-     * @param requestId
-     * @returns
-     */
-    actionGuestLogin(requestId: string): void;
-    /**
-     * offline token check
-     */
-    offlineTokenCheck(accessToken: string): {
-        isExpiryDateValid: boolean;
-        isScopesValid: boolean;
-        isIssuerValid: boolean;
-    };
-}