Search Results for

    Show / Hide Table of Contents

    Method LogonWithSingleSignOn

    LogonWithSingleSignOn(String, String, Int32)

    Logon to a server with single sign on

    Declaration
    LogonResultContract LogonWithSingleSignOn(string tenantName, string clientId, int timeZoneOffsetMinutes)
    Parameters
    Type Name Description
    System.String tenantName

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

    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 "Login with operating system account" access right. See also LoginWithWindowsUser
    You need a InfoShare URL where windows authentication is enabled.

    Examples

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

    Example for a login with windows account.

    {
      "tenantName": "DCIS_KENDOX"
    }

    Response:

    {
       "LogonWithSingleSignOnResult": {
         "AbsenceInfo": {
           "AbsenceDateEnd": "",
           "AbsenceDateStart": "",
           "Absent": false,
           "DeputyRepresentativeUserId": null },
         "ConnectionId": "6bc655a4-c079-4535-a733-f259e3232a3a",
         "ConnectionTimeoutSeconds": 600,
         "IsApplicationLicence": false,
         "IsConcurrentLicence": true,
         "IsNamedLicence": false,
         "IsVerificationCodeNeeded": false,
         "PossibleTwoWayAuthenticationType": "None",
         "TwoWayAuthenticationTargetMail": null }
    }
    Exceptions
    Type Condition
    ServiceException

    Can not login (10006)

    ServiceException

    Can not retrieve windows identity (10007)

    ServiceException

    Tenant not found {tenantName} (10038)

    ServiceException

    Login with windows user not allowed for user {userName} (10052)

    ServiceException

    Too much sessions for user {userName} (10055)

    ServiceException

    No more licences available for the 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

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

    ServiceException

    No interactive login with application user licence allowed (10285)

    Back to top Copyright © Kendox