v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

User login

Obtain a login token

post/v2.0/Login

Headers

Tokenstring

An authentication token. If empty, the token included in the current cookie is used.

Request body

Loginstring required

The user’s email or Login ID

Passwordstring required

The user’s password

formatstring required

The response format (XML or JSON)

IncludeUserEmailboolean

Whether the response includes the user’s email

dateformatstring

The output <a href="https://developer.orangelogic.com/reference/date-and-time">date format</a>

Response

200

Example response

{
  "APIRequestInfo": {
    "ProviderVersion": "LONDON.R2.2131E.216729",
    "ProviderIdentity": "CUY-T-USW2-APP",
    "ProviderID": "73777eae05c8592d0a349f5fa680ecb3",
    "Module": "Authentication",
    "APIVersion": "v2.0",
    "Resource": "Login",
    "IsLoggedIn": true,
    "Status": "LoggedIn",
    "UserLogin": "KristenHarrison",
    "Session": "No session (production configuration)",
    "TimeoutPeriodMinutes": 20
  },
  "APIResponse": {
    "RequestInterpretation": {
      "ParametersInformation": {
        "Login": {
          "Value": "KristenHarrison",
          "ValueCount": 1
        },
        "Password": {
          "Value": "***hidden***",
          "ValueCount": 1
        },
        "IncludeUserEmail": {
          "Value": "false",
          "IsOptional": true,
          "ValueCount": 1
        }
      }
    },
    "Response": {
      "Code": "SUCCESS",
      "Token": "CortexKQBIFTIQDMF8rTjO6XDkvHL.eiV7j3qcLZLazpakbNoKXxgLWTDDNuzlfTzy2U38"
    },
    "ExecutionStatus": "Executed",
    "HTTPCode": 202,
    "Code": "SUCCESS"
  }
}