@c8y/client 1018.487.7 → 1018.496.6

package/lib/cjs/src/tenant/TenantService.d.ts

@@ -0,0 +1,240 @@
+import { Service, IResult, IResultList } from '../core';
+import { ITenant } from './ITenant';
+import { ICurrentTenant } from './ICurrentTenant';
+import { ITfaSettings } from './ITfaSettings';
+import { IApplication } from '../application';
+/**
+ * @description
+ * This service allows for managing tenants.
+ */
+export declare class TenantService extends Service<ITenant> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected currentTenantUrl: string;
+    protected propertyName: string;
+    protected fetchOptions: {
+        method: string;
+        body: string;
+        headers: {
+            'content-type': string;
+            accept: string;
+        };
+    };
+    /**
+     * Get a representation of a tenant.
+     *
+     * @param {string|number|IIdentified} entityOrId Tenant's id or tenant object.
+     *
+     * @returns Returns promise object that is resolved with the IIdentified wrapped by IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const tenantId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantService.detail(tenantId);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_READ<br><br>
+     * User password is never returned in GET response. Authentication mechanism is provided by another interface.
+     */
+    detail(entityOrId: string | number | ITenant): Promise<IResult<ITenant>>;
+    /**
+     * Creates a new tenant.
+     *
+     * @param {IIdentified} entity Tenant object.
+     *
+     * @returns {IResult<IIdentified>} Returns promise object that is resolved with the details of newly created tenant.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const tenantObject = {
+     *    id: "sample_tenant",
+     *    company: "sample_company",
+     *    domain: "sample_domain.com",
+     *    contactName: "Mr. Doe",
+     *    ...
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantService.create(tenantObject);
+     *  })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_ADMIN or ROLE_TENANT_MANAGEMENT_CREATE<br><br>
+     * Note that creating a tenant with adminName, adminPass and adminEmail, creates an admin user with these settings.
+     * For the tenant id SQL keywords (e.g., select, cross, where) are not allowed.
+     */
+    create(entity: ITenant): Promise<IResult<ITenant>>;
+    /**
+     * Updates tenant data.
+     *
+     * @param {IIdentified} entity Tenant is partially updatable.
+     *
+     * @returns {IResult<IIdentified>} Returns promise object that is resolved with the saved tenant object.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const partialUpdateObject: IIdentified = {
+     *     adminName : "newAdmin"
+     *     ...
+     *   }
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantService.update(partialUpdateObject);
+     *  })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_ADMIN or ROLE_TENANT_MANAGEMENT_UPDATE<br><br>
+     * Note that updating adminPass and adminEmail updates these settings in the admin user of the tenant.
+     * Updating adminName has no effect.
+     */
+    update(entity: ITenant): Promise<IResult<ITenant>>;
+    /**
+     * Gets the list of tenants filtered by parameters.
+     *
+     * @param {object} filter Object containing filters for querying tenants.
+     *
+     * @returns Returns promise object that is resolved with the IIdentified wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     severity: Severity.MAJOR,
+     *     pageSize: 100,
+     *     withTotalPages: true
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await tenantService.list(filter);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_READ
+     */
+    list(filter?: object): Promise<IResultList<ITenant>>;
+    /**
+     * Delete a representation of a tenant.
+     *
+     * @param {string|number|IIdentified} entityOrId Tenant's id or tenant object.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const tenantId: string = "uniqueTenantId";
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantService.delete(tenantId);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_ADMIN
+     */
+    delete(entityOrId: string | number | ITenant): Promise<IResult<null>>;
+    current(): Promise<IResult<ICurrentTenant>>;
+    /**
+     * enable support user for current tenant.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *    (async () => {
+     *      const {res} = await tenantService.enableSupportUser();
+     *   })();
+     * ```
+     */
+    enableSupportUser(): Promise<IResult<null>>;
+    /**
+     * disable support user for current tenant.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *    (async () => {
+     *      const {res} = await tenantService.disableSupportUser();
+     *   })();
+     * ```
+     */
+    disableSupportUser(): Promise<IResult<null>>;
+    currentTenantType(): Promise<"TRIAL" | "REGULAR">;
+    /**
+     * Returns two factor-authentication settings for given tenant.
+     *
+     * @param tenant The tenant object.
+     *
+     * @returns Promise which resolves with the object with TFA settings.
+     *
+     * **Example**
+     * ```typescript
+     *   (async () => {
+     *     const currentTenant = (await tenantService.current()).data;
+     *     const currentTenantTfaSettings = await tenantService.getTfaSettings(currentTenant);
+     *
+     *     const subtenant = (await tenantService.detail('t12345')).data;
+     *     const subtenantTfaSettings = await tenantService.getTfaSettings(subtenant);
+     *   })();
+     * ```
+     */
+    getTfaSettings(tenant: ICurrentTenant | ITenant): Promise<ITfaSettings>;
+    /**
+     * Subscribes a given application to a given tenant.
+     *
+     * @param tenant The tenant object.
+     * @param application The application object.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *     const newApp = {
+     *        name: 'New application',
+     *        type: 'HOSTED',
+     *        key: 'new-app'
+     *     };
+     *
+     *     const application = (await applicationService.create(newApp)).data;
+     *     const currentTenant = (await tenantService.current()).data;
+     *
+     *     const {data, res} = await tenantService.subscribeApplication(currentTenant, application);
+     *   })();
+     * ```
+     */
+    subscribeApplication(tenant: ICurrentTenant | ITenant, application: IApplication): Promise<IResult<null>>;
+    /**
+     * Unsubscribes a given application from a given tenant.
+     *
+     * @param tenant The tenant object.
+     * @param application The application object.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *     const newApp = {
+     *        name: 'New application',
+     *        type: 'HOSTED',
+     *        key: 'new-app'
+     *     };
+     *
+     *     const application = (await applicationService.create(newApp)).data;
+     *     const currentTenant = (await tenantService.current()).data;
+     *     await tenantService.addApplication(currentTenant, application);
+     *
+     *     await tenantService.unsubscribeApplication(currentTenant, application);
+     *   })();
+     * ```
+     */
+    unsubscribeApplication(tenant: ICurrentTenant | ITenant, application: IApplication): Promise<IResult<null>>;
+    protected getIdString(tenant: ITenant | ICurrentTenant): string;
+    protected onBeforeCreate(obj: ITenant): any;
+}
+//# sourceMappingURL=TenantService.d.ts.map

package/lib/cjs/src/tenant/TenantStatus.d.ts

@@ -0,0 +1,5 @@
+export declare enum TenantStatus {
+    ACTIVE,
+    SUSPENDED
+}
+//# sourceMappingURL=TenantStatus.d.ts.map

package/lib/cjs/src/tenant/TfaStrategy.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents a strategy used for two-factor authentication.
+ */
+export declare enum TfaStrategy {
+    /** Two-factor authentication with Time-Based One Time Passwords. */
+    TOTP = "TOTP",
+    /** Two-factor authentication with codes sent via SMSes. */
+    SMS = "SMS"
+}
+//# sourceMappingURL=TfaStrategy.d.ts.map

package/lib/cjs/src/tenant/index.d.ts

@@ -0,0 +1,8 @@
+export * from './TenantService';
+export * from './ITenant';
+export * from './ICurrentTenant';
+export * from './ITenantReference';
+export * from './TenantStatus';
+export * from './ITfaSettings';
+export * from './TfaStrategy';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/tenant-login-options/ITenantLoginOptions.d.ts

@@ -0,0 +1,152 @@
+/**
+ * A list of supported [[ITenantLoginOption]] which
+ * describe the way a user can login to the Platform.
+ */
+import { TfaStrategy } from '../tenant';
+export interface ITenantLoginOptions {
+    /**
+     * Link to the resource
+     */
+    self?: string;
+    /**
+     * The list of tenant login options
+     */
+    loginOptions: ITenantLoginOption[];
+}
+/**
+ * Describes the login option which can be requested by any
+ * application on startup without login. It describes which kind
+ * of login mechanism (e.g. Basic, SSO or OAI-Secure) is
+ * supported by the current Platform.
+ */
+export interface ITenantLoginOption {
+    /**
+     * Identifies the login option
+     */
+    id?: string;
+    /**
+     * Login option type
+     */
+    type?: TenantLoginOptionType;
+    /**
+     * Grant type
+     */
+    grantType?: GrantType;
+    /**
+     * The origin of the users REMOTE or INTERNAL
+     */
+    userManagementSource: UserManagementSource;
+    /**
+     * Link to the resource
+     */
+    self?: string;
+    /**
+     * The strategy for Two Factor Authentication
+     */
+    tfaStrategy?: TfaStrategy;
+    /**
+     * Indicates whether the login option should be visible on the login page of UI applications.
+     * If set to `true` for more than one login option, then the preferred one will be selected according to priority:
+     * 1. OAI-Secure: authentication information is stored in a HttpOnly cookie
+     * 2. Basic Auth: authentication information is stored in a session storage
+     * 3. SSO redirect: allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol.
+     * If no login option has `visibleOnLoginPage` set to `true`, the preferred login option will be Basic Auth.
+     */
+    visibleOnLoginPage?: boolean;
+    /**
+     * The label which is shown on the login button
+     */
+    buttonName?: string;
+    /**
+     * The request which is used to initialize an oauth flow
+     */
+    initRequest?: string;
+    /**
+     * Determines if password strength is enforced on system level
+     */
+    enforceStrength?: boolean;
+    /**
+     * Minimum length of a password to be considered as a “green” strong one
+     */
+    greenMinLength?: number;
+    /**
+     * Determines if password strength is enforced on tenant level
+     */
+    strengthValidity?: boolean;
+    /**
+     * Organizations name which provides login option
+     */
+    providerName?: string;
+    /**
+     * Basic authentication restrictions.
+     */
+    authenticationRestrictions?: IAuthenticationRestrictions;
+    /**
+     * Configuration for OAI-Secure sessions.
+     */
+    sessionConfiguration?: ISessionConfiguration;
+    /**
+     * Tenant correct domain for OAI-Secure login option.
+     * UI will redirect to this domain if OAI-Secure is
+     * set as preferred login mode and domain in browser is wrong.
+     */
+    loginRedirectDomain?: string;
+}
+export interface IAuthenticationRestrictions {
+    /**
+     * The list of user agents which are allowed to use the platform's REST API.
+     * The values are compared with `User-Agent` HTTP header.
+     */
+    trustedUserAgents: string[];
+    /**
+     * The list of user agents which are forbidden to use the platform's REST API.
+     * The values are compared with `User-Agent` HTTP header.
+     */
+    forbiddenUserAgents: string[];
+    /**
+     * The list of clients which are forbidden to use the platform's REST API.
+     * For now, the only value supported in the array is `'WEB_BROWSERS'` (which blocks all web browsers).
+     */
+    forbiddenClients: string[];
+}
+export interface ISessionConfiguration {
+    /**
+     * The maximum amount of time a session can be active.
+     */
+    absoluteTimeoutMillis: number;
+    /**
+     * The maximum amount of sessions per user.
+     */
+    maximumNumberOfParallelSessions: number;
+    /**
+     * The timeout after which the session id is automatically renewed. If there is no activity after renewal timeout and before absolute session timeout, the session will not be renewed.
+     */
+    renewalTimeoutMillis: number;
+    /**
+     * If `true`, then every request needs to use the same `User-Agent` header as the first request which initiated the session.
+     */
+    userAgentValidationRequired: boolean;
+}
+export declare enum TenantLoginOptionType {
+    /**
+     * OAI-Secure: authentication information is stored in a HttpOnly cookie
+     */
+    OAUTH2_INTERNAL = "OAUTH2_INTERNAL",
+    /**
+     * SSO redirect: allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol.
+     */
+    OAUTH2 = "OAUTH2",
+    /**
+     * Basic Auth: authentication information is stored in a session storage
+     */
+    BASIC = "BASIC"
+}
+export declare enum GrantType {
+    AUTHORIZATION_CODE = "AUTHORIZATION_CODE",
+    PASSWORD = "PASSWORD"
+}
+export declare enum UserManagementSource {
+    REMOTE = "REMOTE",
+    INTERNAL = "INTERNAL"
+}
+//# sourceMappingURL=ITenantLoginOptions.d.ts.map

package/lib/cjs/src/tenant-login-options/TenantLoginOptionsService.d.ts

@@ -0,0 +1,170 @@
+import { IIdentified, IResult, IResultList, Service } from '../core';
+import { ITenantLoginOption } from './ITenantLoginOptions';
+/**
+ * @description
+ * This service allows to get tenant login options.
+ */
+export declare class TenantLoginOptionsService extends Service<ITenantLoginOption> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected propertyName: string;
+    /**
+     * Gets the details of login option.
+     *
+     * @param entityIdentityOrId Login option's id or login option object.
+     *
+     * @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantLoginOptionsService.detail(tenantLoginOptionId);
+     *   })();
+     * ```
+     */
+    detail(entityIdentityOrId: string | IIdentified): Promise<IResult<ITenantLoginOption>>;
+    /**
+     * Gets the list of tenant's login options filtered by parameters.
+     *
+     * @param filter Object containing filters for querying tenant's login options.
+     *
+     * @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     tenantId: '1111111'
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await tenantLoginOptionsService.list(filter);
+     *   })();
+     * ```
+     */
+    list(filter?: object): Promise<IResultList<ITenantLoginOption>>;
+    /**
+     * Gets the list of all tenant's login options for current tenant.
+     *
+     * @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await tenantLoginOptionsService.listForCurrentTenant();
+     *   })();
+     * ```
+     */
+    listForCurrentTenant(): Promise<IResultList<ITenantLoginOption>>;
+    /**
+     * Gets the list of all tenant's login options for management tenant.
+     *
+     * @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await tenantLoginOptionsService.listForManagement();
+     *   })();
+     * ```
+     */
+    listForManagement(): Promise<IResultList<ITenantLoginOption>>;
+    /**
+     * Creates a new tenant login option.
+     *
+     * @param entity ITenantLoginOption object.
+     *
+     * @returns Returns promise object that is resolved with the details of newly created tenant login option.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const tenantLoginOption: ITenantLoginOption = {
+     *    grantType: "PASSWORD",
+     *    providerName: "Cumulocity",
+     *    type: "BASIC",
+     *    userManagementSource: "INTERNAL",
+     *    visibleOnLoginPage: true
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantLoginOptionsService.create(tenantLoginOption);
+     *  })();
+     * ```
+     */
+    create(entity: ITenantLoginOption): Promise<IResult<ITenantLoginOption>>;
+    /**
+     * Updates tenant's login option data.
+     *
+     * @param entity ITenantLoginOption object.
+     *
+     * @returns Returns promise object that is resolved with the saved tenant's login option object.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const tenantLoginOption: ITenantLoginOption = {
+     *    grantType: "PASSWORD",
+     *    id: "2eff9a0b-e376-4ce8-a0f1-0a07cef8a8a1",
+     *    providerName: "Cumulocity",
+     *    type: "BASIC",
+     *    userManagementSource: "INTERNAL",
+     *    visibleOnLoginPage: true
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantLoginOptionsService.update(tenantLoginOption);
+     *  })();
+     * ```
+     */
+    update(entity: ITenantLoginOption): Promise<IResult<ITenantLoginOption>>;
+    /**
+     * Update tenant's login option data if id exists in object, otherwise create new entity.
+     *
+     * @param entity ITenantLoginOption object.
+     *
+     * @returns Returns promise object that is resolved with the saved tenant's login option object.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const tenantLoginOption: ITenantLoginOption = {
+     *    grantType: "PASSWORD",
+     *    id: "2eff9a0b-e376-4ce8-a0f1-0a07cef8a8a1",
+     *    providerName: "Cumulocity",
+     *    type: "BASIC",
+     *    userManagementSource: "INTERNAL",
+     *    visibleOnLoginPage: true
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantLoginOptionsService.save(tenantLoginOption);
+     *  })();
+     * ```
+     */
+    save(entity: ITenantLoginOption): Promise<IResult<ITenantLoginOption>>;
+    /**
+     * Removes tenant's login option.
+     *
+     * @param entityOrId Tenant's login option's id or tenant's login option object.
+     *
+     * @returns Returns promise object that is resolved with the IResult of null.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantLoginOptionsService.delete(tenantLoginOptionId);
+     *   })();
+     * ```
+     */
+    delete(entityOrId: string | IIdentified): Promise<IResult<null>>;
+}
+//# sourceMappingURL=TenantLoginOptionsService.d.ts.map

package/lib/cjs/src/tenant-login-options/index.d.ts

@@ -0,0 +1,3 @@
+export * from './TenantLoginOptionsService';
+export * from './ITenantLoginOptions';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/tenant-options/ITenantOption.d.ts

@@ -0,0 +1,10 @@
+/** Description of ITenantOption interface */
+export interface ITenantOption {
+    /** Category of option */
+    category: string;
+    /** Key of option */
+    key: string;
+    /** Value of option */
+    value?: string;
+}
+//# sourceMappingURL=ITenantOption.d.ts.map

package/lib/cjs/src/tenant-options/ITenantOptionDetailParams.d.ts

@@ -0,0 +1,11 @@
+/** Query parameters for requesting tenant option's detail. */
+export interface ITenantOptionDetailParams {
+    /**
+     * Determines in which context the value of a tenant option will be evaluated:
+     * - `current`: will return the value which is explicitly set in the current tenant,
+     * - `inherited`: will return the value which is inherited from the parent tenant,
+     * - by default it will return either the value from current tenant or from parent tenant (if the former is not set).
+     */
+    evaluate?: 'current' | 'inherited';
+}
+//# sourceMappingURL=ITenantOptionDetailParams.d.ts.map