Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TenantService

Hierarchy

Index

Constructors

constructor

Methods

create

  • Parameters

    Returns Promise<IResult<ITenant>>

    Returns promise object that is resolved with the details of newly created tenant.

    Example

    
     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

    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.

current

currentTenantType

  • currentTenantType(): Promise<"TRIAL" | "REGULAR">
  • Returns Promise<"TRIAL" | "REGULAR">

delete

  • delete(entityOrId: string | number | ITenant): Promise<IResult<null>>
  • Parameters

    • entityOrId: string | number | ITenant

    Returns Promise<IResult<null>>

    Returns promise object that is resolved with the IResult.

    Example

    
       const tenantId: string = "uniqueTenantId";
    
       (async () => {
         const {data, res} = await tenantService.delete(tenantId);
      })();
    

    Required role: ROLE_TENANT_MANAGEMENT_ADMIN

detail

  • Parameters

    • entityOrId: string | number | ITenant

    Returns Promise<IResult<ITenant>>

    Returns promise object that is resolved with the IIdentified wrapped by IResult.

    Example

    
       const tenantId: number = 1;
    
       (async () => {
         const {data, res} = await tenantService.detail(tenantId);
      })();
    

    Required role: ROLE_TENANT_MANAGEMENT_READ

    User password is never returned in GET response. Authentication mechanism is provided by another interface.

disableSupportUser

  • disableSupportUser(): Promise<IResult<null>>
  • Returns Promise<IResult<null>>

    Returns promise object that is resolved with the IResult.

    Example

       (async () => {
         const {res} = await tenantService.disableSupportUser();
      })();
    

enableSupportUser

  • enableSupportUser(): Promise<IResult<null>>
  • Returns Promise<IResult<null>>

    Returns promise object that is resolved with the IResult.

    Example

       (async () => {
         const {res} = await tenantService.enableSupportUser();
      })();
    

getTfaSettings

  • Parameters

    Returns Promise<ITfaSettings>

    Promise which resolves with the object with TFA settings.

    Example

      (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);
      })();
    

list

  • Parameters

    • Default value filter: object = {}

    Returns Promise<IResultList<ITenant>>

    Returns promise object that is resolved with the IIdentified wrapped by IResultList.

    Example

    
     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$

  • Parameters

    Returns Observable<ITenant[]>

    Data wrapped as Observable.

    Example

    
      const list$ = tenantService.list$();
      list$.subscribe((data) => console.log(data));
    

    Deprecated This function will be removed soon in favor of decoupling this library from rxjs. Use Realtime for realtime connection and rxjs defer() or from() to composite an observable on your own.

update

  • Parameters

    Returns Promise<IResult<ITenant>>

    Returns promise object that is resolved with the saved tenant object.

    Example

    
     const partialUpdateObject: IIdentified = {
        adminName : "newAdmin"
        ...
      }
    
     (async () => {
       const {data, res} = await tenantService.update(partialUpdateObject);
     })();
    

    Required role: ROLE_TENANT_MANAGEMENT_ADMIN or ROLE_TENANT_MANAGEMENT_UPDATE

    Note that updating adminPass and adminEmail updates these settings in the admin user of the tenant. Updating adminName has no effect.

Generated using TypeDoc