Pobieranie kontekstu zalogowanego użytkownika

API pozwala na pobranie kontekstu użytkownika aktualnie wypełniającego formularz. Kontekst opisuje użytkowników zalogowanych na formularzu, w aplikacji Dashboard czy aplikacjach klienta zintegrowanych z systemem Eximee oraz informacje o sesji użytkownika niezalogowanego.

Funkcjonalność dostępna od wersji platformy: 4.737.0

Funkcjonalność działa na wnioskach uruchamianych w aplikacji webforms.

---

API

interface User {
    v1: {
        getIdentity(): UserIdentity
    }
}


interface UserIdentity {
    userId(): string,
    roles(): string[],
    firstName(): string,
    lastName(): string,
    type(): 'client'|'employee'|'otp',
    system(): string
}

Pola: firstName, lastName, roles są zależne od sposobu integracji uwierzytelniania w ramach wdrożenia.

Najczęściej pola są dostępne jedynie dla uwierzytelnienia typu Pracownik (employee) w systemach Dashboard lub systemach Klienta zintegrowanych z Eximee.

Kontekst działania

API jest dostępne z obiektu api.user.v1 i działa w kontekście formularza.

Obsługuje użytkowników pracujących z formularzem:

• zalogowanych przez kanał Web zgodnie z integracją wdrożenia,
• zalogowanych przez aplikację Dashboard,
• zalogowanych przez autoryzację zintegrowanych systemów wdrożenia,
• niezalogowanych w podstawowym zakresie rozróżnialności użytkowników.

---

Przykłady użycia

Pobieranie danych użytkownika

function callService(context) {
    const identity = api.user.v1.getIdentity();
    Logger.info("Get user identity: {}", identity)
    return [{
        'userId': identity.userId,
        'firstName': identity.firstName,
        'lastName': identity.lastName,
        'type': identity.type,
        'system': identity.system,
    }];
} 

Przykład użycia w skrypcie

function callService(context) {
    const AVAILABLE_ROLES = ["EXIMEE_BROKER_MORTGAGE_DASHBOARD"]
    let identity = api.user.v1.getIdentity()
    let roles = identity.roles
    Logger.info("simpleMortgageExecutionPermissionVerify roles: {}", roles)

    if (!roles) {
        throwBusinessError("error_page_default-*", "Brak uprawnien do uruchomienia procesu")
    }
    let isAvailableRole = roles.some(role => AVAILABLE_ROLES.includes(role.toUpperCase()))

    if (!isAvailableRole) {
        throwBusinessError("error_page_default-*", "Brak odpowiedniej roli do uruchomienia procesu")

    }
    let userId = identity.userId
    return [{ userId }];

    function throwBusinessError(textcontentName, errorDescription) {
        const builder = context.getErrorPageDefinitionBuilder();
        builder.bodyTextContent(textcontentName);
        builder.msg(errorDescription);
        context.throwBusinessException(builder);
    }
}