URL: /DMLogin/Login

Method: POST

Descrizione

Il metodo consente di effettuare l'autenticazione a DocsMarshal tramite username e password, e ritorna un Session ID che potrà essere usato per autenticarsi nelle chiamate successive.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
    'username': 'user',
    'password': 'pass',
    'softwareName': 'SW01',
    'impersonateUserId': 10,
    'impersonateUserExternalId': 'User01',
    'otp': '123456',
    'mfaToken': 'XXXXXXXXXXXXXXXXXXXXXX',
    'skipMfa': false
}

Formato risposte

{
    "result":
    {
        "LoggedIn": true,
        "SessionId": "4b720da7-cd6a-4974-8a5a-0e02ed61ce26",
        "ExpirationDateTime": "/Date(1456421186307)/",
        "UserName": "Paolo Rossi",
        "FirstName": "Paolo",
        "LastName": "Rossi",
        "UserId": 5,
        "RequiredMfaMode": 0,
        "MfaTokenIsSet": false
    }
}

Note

Da notare che questo è un endpoint dell'API che non ritorna una risposta standard. Il valore di ritorno è un oggetto JSON ma non possiede i campi HasError ed Error.
Si può sapere se il login è andato a buon fine controllando il campo LoggedIn.
I parametri impersonateUserId e impersonateUserExternalId consentono di eseguire l'impersonificazione immediata nell'utente indicato.