Search Results for

    Show / Hide Table of Contents

    Method LogonWithNewPassword

    LogonWithNewPassword(String, String, String, String, String, Int32)

    Logon to server with username and password and sets a new password

    Declaration
    LogonResultContract LogonWithNewPassword(string tenantName, string userName, string passwordHashed, string newPassword, string clientId, int timeZoneOffsetMinutes)
    Parameters
    Type Name Description
    System.String tenantName

    Optional: Tenant name to logon to. See also GetAllTenantNames()

    System.String userName

    User name for logon

    System.String passwordHashed

    Optional: User password for logon (Base64 encoded SHA 512 Hash)

    System.String newPassword

    New password to set (clear text)

    System.String clientId

    Optional: The unique identifier of the client program used for licence validation. Default: null

    System.Int32 timeZoneOffsetMinutes

    Deprecated: The offset in minutes between client time zone and UTC. Should not longer be used. Default value 0.

    Returns
    Type Description
    LogonResultContract

    Return the logon result with the connection id

    Remarks
    • Connection will be automatically closed after the defined idle timeout (default: 10 minutes). See also ConnectionTimeoutSeconds
    • User needs either "Login with internal password" or "Login without password" access right. See also LoginWithInternalPassword and LoginWithoutPassword
    Examples

    POST https://YourServerName/InfoShare/Json/Authentication/LogonWithNewPassword

    Example for a login with the user john.doe and a new password.

    {
       "tenantName": "DCIS_KENDOX",
       "userName": "john.doe",
       "passwordHashed": "iow3xk39qv9+ElxY1a1Ke4hDvFph5qO9m9CTp8ykqR22BCRblioNMa90uk3TtG7ReogG168Zj33ohxTdKC2kmA==",
       "newPassword": "Qhb/vWJEcf9UPQVGdeqt/OilAz0jSHAPQR8/NbuUgfOoRipP1OPZR5QQhvRTugZ1gNSd3FaXcnmRYrEeeIL7hQ=="
    }

    Response:

    {
       "LogonWithNewPasswordResult": {
         "AbsenceInfo": {
           "AbsenceDateEnd": "2023-04-14T17:00:04",
           "AbsenceDateStart": "2023-02-12T13:45:04",
           "Absent": true,
           "DeputyRepresentativeUserId": "861dfa14-6f45-ed11-a4c9-00155df08701" },
         "ConnectionId": "6bc655a4-c079-4535-a733-f259e3232a3a",
         "ConnectionTimeoutSeconds": 600,
         "IsApplicationLicence": false,
         "IsConcurrentLicence": true,
         "IsNamedLicence": false,
         "IsVerificationCodeNeeded": false,
         "PossibleTwoWayAuthenticationType": "None",
         "TwoWayAuthenticationTargetMail": null,
         "JWTToken": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8...." }
    }
    Exceptions
    Type Condition
    ServiceException

    Can not login (10006)

    ServiceException

    Tenant not found {tenantName} (10038)

    ServiceException

    Too much sessions for user {userName} (10055)

    ServiceException

    No more licences available for user {userName} (10056)

    ServiceException

    Named user licence not available {userName} (10057)

    ServiceException

    Wrong client Id parameter (10089)

    ServiceException

    Missing feature in server license {featureId} (10100)

    ServiceException

    Two way authentication type ({twoWayAuthenticationType}) is invalid. Valid types are: {allowedTwoWayAuthenticationTypes} (10148)

    ServiceException

    Could not parse int {flag} to a valid two way authentication type (10154)

    ServiceException

    Login failed for user {userName}: {message} (10175)

    ServiceException

    Invalid ip address for user: '{userName}' (10222)

    ServiceException

    No interactive login with application user licence allowed (10285)

    ServiceException

    ExternalUser must have two factor authentication enabled (10374)

    Back to top Copyright © Kendox