Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TenantLoginOptionsService

Hierarchy

Index

Constructors

constructor

Methods

create

  • Parameters

    Returns Promise<IResult<ITenantLoginOption>>

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

    Example

    
     const tenantLoginOption: ITenantLoginOption = {
       grantType: "PASSWORD",
       providerName: "Cumulocity",
       type: "BASIC",
       userManagementSource: "INTERNAL",
       visibleOnLoginPage: true
     };
    
     (async () => {
       const {data, res} = await tenantLoginOptionsService.create(tenantLoginOption);
     })();
    

delete

  • Parameters

    Returns Promise<IResult<null>>

    Returns promise object that is resolved with the IResult of null.

    Example

    
       const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
    
       (async () => {
         const {data, res} = await tenantLoginOptionsService.delete(tenantLoginOptionId);
      })();
    

detail

  • Parameters

    Returns Promise<IResult<ITenantLoginOption>>

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

    Example

    
       const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
    
       (async () => {
         const {data, res} = await tenantLoginOptionsService.detail(tenantLoginOptionId);
      })();
    

list

  • Parameters

    • Default value filter: object = {}

    Returns Promise<IResultList<ITenantLoginOption>>

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

    Example

    
     const filter: object = {
        tenantId: '1111111'
      };
    
      (async () => {
        const {data, res, paging} = await tenantLoginOptionsService.list(filter);
      })();
    

listForCurrentTenant

  • Returns Promise<IResultList<ITenantLoginOption>>

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

    Example

    
      (async () => {
        const {data, res, paging} = await tenantLoginOptionsService.listForCurrentTenant();
      })();
    

listForManagement

  • Returns Promise<IResultList<ITenantLoginOption>>

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

    Example

    
      (async () => {
        const {data, res, paging} = await tenantLoginOptionsService.listForManagement();
      })();
    

save

  • Parameters

    Returns Promise<IResult<ITenantLoginOption>>

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

    Example

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

update

  • Parameters

    Returns Promise<IResult<ITenantLoginOption>>

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

    Example

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

Generated using TypeDoc