Class TenantOptionsService

Returns TenantOptionsService

Returns Promise<IResult<ITenantOption>>

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

Example

 const tenantObject = {
   id: "sample_tenant",
   company: "sample_company",
   domain: "sample_domain.com",
   contactName: "Mr. Doe",
   ...
 };

 (async () => {
   const {data, res} = await tenantService.create(tenantObject);
 })();
Copy

Required role: ROLE_OPTION_MANAGEMENT_ADMIN

Options are category-key-value tuples, storing tenant configuration.Some categories of options allow creation of new one, other are limited to predefined set of keys.

Any option of any tenant can be defined as "non-editable" by "management" tenant. Afterwards, any PUT or DELETE requests made on that option by the owner tenant, will result in 403 error (Unauthorized).

Returns Promise<IResult<null>>

Returns promise object that is resolved with the IResult.

Example

   const tenantOptionId: string = "uniqueTenantId";

   (async () => {
     const {data, res} = await tenantOptionsService.delete(tenantOptionId);
  })();
Copy

Required role: ROLE_TENANT_MANAGEMENT_ADMIN

Returns Promise<IResult<ITenantOption>>

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

Example

const option: ITenantOption = {
  category: 'access.control',
  key: 'allow.origin'
};
const params: ITenantOptionDetailParams = {
  evaluate: 'inherited'
};
(async () => {
  const { data, res } = await tenantService.detail(option);
  console.log('value inherited from parent tenant:', data.value);
})();
Copy

Required role: ROLE_OPTION_MANAGEMENT_READ

Returns Promise<IResultList<ITenantOption>>

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

Example

 const filter: object = {
    severity: Severity.MAJOR,
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await tenantOptionsService.list(filter);
  })();
Copy

Required role: ROLE_OPTION_MANAGEMENT_READ

Returns Promise<IResult<ITenantOption>>

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

Example

 const partialUpdateObject: IIdentified = {
    value : "http://developer.cumulocity.com"
    ...
  }

 (async () => {
   const {data, res} = await tenantOptionsService.update(partialUpdateObject);
 })();
Copy

Required role: ROLE_OPTION_MANAGEMENT_ADMIN