gigya-node/dist/lib/admin.d.ts

Gigya SDK for NodeJS

import Gigya from './gigya';
import { BaseParamsSite } from './interfaces/base-params';
import { CaptchaProvider } from "./interfaces/captchaProvider";
import { CoreOptions } from 'request';
export * from './interfaces/gigya-response';
export * from './interfaces/base-params';
export declare class Admin {
    protected gigya: Gigya;
    constructor(gigya: Gigya);
    /**
     * This method creates a new site.
     *
     * @see http://developers.gigya.com/display/GD/admin.createSite+REST
     */
    createSite(params: BaseParamsSite & AdminCreateSiteParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminCreateSiteResponse>;
    /**
     * This API retrieves a partner's previously-saved ACL and its description, or a built-in ACL.
     *
     * @see http://developers.gigya.com/display/GD/admin.getACL+REST
     */
    getEffectiveACL(params: BaseParamsSite & (AdminGetEffectiveACLTargetUserKeyParams | AdminGetEffectiveACLGroupIDsParams), options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminGetEffectiveACLResponse>;
    /**
     * This API retrieves a specified partner's information.
     *
     * @see http://developers.gigya.com/display/GD/admin.getPartner+REST
     */
    getPartner(params: BaseParamsSite & AdminGetPartnerParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminGetPartnerResponse>;
    /**
     * This API retrieves a partner's previously-saved ACL and its description, or a built-in ACL.
     *
     * @see http://developers.gigya.com/display/GD/admin.getACL+REST
     */
    getSiteConfig(params: BaseParamsSite & AdminGetSiteConfigParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminGetSiteConfigResponse>;
    /**
     * This API returns either all sites with which a user is associated by way of group memberships or all sites in a specific partner with which a user is associated.
     *
     * @see http://developers.gigya.com/display/GD/admin.getUserSites+REST
     */
    getUserSites(params: BaseParamsSite & AdminGetUserSitesParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminGetUserSitesResponse>;
    /**
     * This method searches the partner IDs, site IDs, base domains, and company names.
     *
     * @see http://developers.gigya.com/display/GD/admin.search+REST
     */
    search(params: BaseParamsSite & AdminSearchParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse & AdminSearchResponse>;
    /**
     * This method sets the configuration for existing sites.
     *
     * @see http://developers.gigya.com/display/GD/admin.setSiteConfig+REST
     */
    setSiteConfig(params: BaseParamsSite & AdminSetSiteConfigParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse>;
    /**
     * This method deletes an exisiting site by API key
     *
     * @see http://developers.gigya.com/display/GD/admin.deleteSite+REST
     */
    deleteSite(params: BaseParamsSite & AdminDeleteSiteParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse>;
    /**
     * This method updates an exisiting partner by partnerID
     *
     * @see https://developers.gigya.com/display/GD/admin.updatePartner+REST
     */
    updatePartner(params: BaseParamsSite & AdminUpdatePartnerParams, options?: CoreOptions | undefined): Promise<import("./gigya").GigyaResponse>;
}
export interface AdminCreateSiteParams {
    partnerID: number | string;
    baseDomain: string;
    description?: string;
    dataCenter?: string;
    isGlobalSite?: boolean;
    secondaryDataCenters?: Array<string>;
}
export interface AdminCreateSiteResponse {
    apiKey: string;
}
export interface AdminGetEffectiveACLTargetUserKeyParams {
    partnerID: number | string;
    targetUserKey: string;
    apiKey?: string;
}
export interface AdminGetEffectiveACLGroupIDsParams {
    partnerID: number | string;
    groupIds: string;
    apiKey?: string;
}
export interface AdminGetEffectiveACLResponse {
    eACL: {
        _api: {
            [namespace: string]: {
                [method: string]: {
                    _ace: {
                        perms: 'x';
                    };
                };
            };
        };
        _inherit: Array<string>;
    };
}
export interface AdminServices {
    gm?: {
        enabled: boolean;
    };
    comments?: {
        enabled: boolean;
    };
    accounts?: {
        enabled: boolean;
        features: Array<string>;
    };
    audit?: {
        enabled: boolean;
    };
    ds?: {
        enabled: boolean;
    };
    ids?: {
        enabled: boolean;
    };
    samlIdp?: {
        enabled: boolean;
    };
    nexus?: {
        enabled: boolean;
        features: Array<string>;
    };
    defaultDBSize: string;
    defaultDataCenter: string;
    customData: {
        websiteURL: string;
        companyName: string;
    };
    secretKey: string;
    liteAccount?: {
        enabled: boolean;
    };
    subscriptions?: {
        enabled: boolean;
    };
}
export interface AdminGetPartnerParams {
    partnerID: number | string;
}
export interface AdminGetPartnerResponse {
    partnerID: number;
    isTrial: boolean;
    isEnabled: boolean;
    services: AdminServices;
    defaultDataCenter: string;
    customData: {
        websiteURL: string;
        companyName: string;
    };
    secretKey: string;
    auditRetention: number | string;
}
export interface AdminUserSite {
    siteID: number;
    apiKey: string;
    baseDomain: string;
    description: string;
    dataCenter: string;
}
export interface AdminGetUserSitesParams {
    targetUserKey?: string;
    targetPartnerID?: number;
}
export interface AdminGetUserSitesResponse {
    sites: Array<{
        partnerID: number;
        sites: Array<AdminUserSite>;
    }>;
}
export interface AdminGetSiteConfigParams {
    apiKey: string;
    includeServices?: boolean;
    includeSiteGroupConfig?: boolean;
    includeSiteID?: boolean;
    explicitSiteGroupConfig?: boolean;
    explicitSiteConfig?: boolean;
    includeGigyaSettings?: boolean;
    includeGlobalConf?: boolean;
    includeGlobalSiteSettings?: boolean;
}
export interface AdminGetSiteConfigResponse {
    baseDomain: string;
    dataCenter: string;
    trustedSiteURLs: Array<string>;
    description: string;
    captchaProvider: CaptchaProvider;
    services: AdminServices;
    siteID: number;
    gigyaSettings: {
        enableRequestLoggingUntil: string;
        dsSize: string;
        enableSSLForCNAME: boolean;
        customAPIDomainPrefix: string;
    };
    settings: {
        CNAME: string;
        shortURLDomain: string;
        shortURLRedirMethod: string;
    };
    siteGroupConfig: {
        members?: Array<string>;
        enableSSO: boolean;
        SSOSegment: string;
    };
    siteGroupOwner?: string;
    enableDataSharing: boolean;
    trustedShareURLs: Array<string>;
    logoutURL?: string;
    globalConf?: string;
    isGlobalSite: boolean;
    invisibleRecaptcha?: {
        siteKey?: string;
        secret?: string;
    };
    recaptchaV2?: {
        siteKey?: string;
        secret?: string;
    };
    funCaptcha?: {
        siteKey?: string;
        secret?: string;
    };
    globalSiteSettings?: {
        secondaryDatacenters: Array<string>;
    };
}
export interface AdminSetSiteConfigParams {
    apiKey: string;
    baseDomain?: string;
    dataCenter?: string;
    trustedSiteURL?: Array<string>;
    description?: string;
    captchaProvider: CaptchaProvider;
    logoutURL?: string;
    services?: {
        gm?: {
            enabled: boolean;
        };
        comments?: {
            enabled: boolean;
        };
        accounts?: {
            enabled: boolean;
            features: Array<string>;
        };
        audit?: {
            enabled: boolean;
        };
        ds?: {
            enabled: boolean;
        };
        ids?: {
            enabled: boolean;
        };
        samlIdp?: {
            enabled: boolean;
        };
        nexus?: {
            enabled: boolean;
            features: Array<string>;
        };
        defaultDBSize?: string;
        defaultDataCenter?: string;
        customData?: {
            websiteURL?: string;
            companyName?: string;
        };
    };
    gigyaSettings?: {
        enableRequestLoggingUntil?: string;
        dsSize?: string;
        enableSSLForCNAME?: boolean;
        customAPIDomainPrefix?: string;
    };
    settings?: {
        CNAME?: string;
        shortURLDomain?: string;
        shortURLRedirMethod?: string;
    };
    siteGroupConfig?: {
        enableSSO?: boolean;
        SSOSegment?: string;
    };
    siteGroupOwner?: string | null;
    enableDataSharing?: boolean;
    trustedShareURLs?: Array<string>;
    globalConf?: string;
    invisibleRecaptcha?: {
        siteKey?: string;
        secret?: string;
    };
    recaptchaV2?: {
        siteKey?: string;
        secret?: string;
    };
    funCaptcha?: {
        siteKey?: string;
        secret?: string;
    };
}
export interface AdminSearchParams {
    query: string;
}
export interface AdminSearchResponse {
    data: Array<{
        partnerID: number;
        companyName: string;
        isTrial: boolean;
    }>;
}
export interface AdminDeleteSiteParams {
    apiKey: string;
    deleteToken?: string;
    format?: string;
    callback?: string;
    httpStatusCodes?: boolean;
}
export interface AdminUpdatePartnerParams {
    partnerID: string;
    defaultDataCenter?: string;
    isEnabled?: boolean;
    isMigratedToSoa?: boolean;
    isTrial?: boolean;
    tenantID?: string;
    format?: string;
    services?: AdminServices;
    auditRetention?: string | number;
}
export default Admin;