Optionalrealtime: RealtimeCreates a new tenant login option.
ITenantLoginOption object.
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);
})();
Removes tenant's login option.
Tenant's login option's id or tenant's login option object.
Returns promise object that is resolved with the IResult of null.
Example
const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
(async () => {
const {data, res} = await tenantLoginOptionsService.delete(tenantLoginOptionId);
})();
Gets the details of login option.
Login option's id or login option object.
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);
})();
Gets the list of tenant's login options filtered by parameters.
Object containing filters for querying tenant's login options.
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);
})();
Gets the list of all tenant's login options for current tenant.
Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
Example
(async () => {
const {data, res, paging} = await tenantLoginOptionsService.listForCurrentTenant();
})();
Gets the list of all tenant's login options for management tenant.
Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
Example
(async () => {
const {data, res, paging} = await tenantLoginOptionsService.listForManagement();
})();
Update tenant's login option data if id exists in object, otherwise create new entity.
ITenantLoginOption object.
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);
})();
Updates tenant's login option data.
ITenantLoginOption object.
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);
})();
Description
This service allows to get tenant login options.