--- updatedAt: 2026-07-30T11:03:34.000Z agentTools: projectIndex: https://developer.orangelogic.com/llms.txt --- # User login Obtain a login token The response to this call is a token that you can use to authenticate subsequent API calls. This token can be used only with HTTP requests from the IP address that requested the token. > ❗ Warning > > This is the least secure [authentication method](https://developer.orangelogic.com/reference/authentication). > ℹ️ Notes > > * To use the user login endpoint, you must have the **Authorize to log in using an API** call [Security Function](https://developer.orangelogic.com/reference/api-testing#orange-logic-security-functions-and-permissions). > * When you log in, either via API or with the Orange Logic interface, your web browser creates a session cookie that is valid for both the user interface and API calls. The cookie remains active for the duration of the session. As long as you remain logged in and continue to use the same browser, you don’t need to provide a token to authenticate API calls. If you provide an invalid token while a valid cookie is in effect, Orange Logic accepts the cookie and ignores the token. ## Response headers This API returns [standard headers](https://developer.orangelogic.com/reference/responses-headers#headers) in an **APIRequestInfo** section. In addition, this API returns an **APIResponse** section that shows how Orange Logic has interpreted the user information provided. This section of the response includes a user login name, password, and email. Use this information to verify that the token you receive is authentication for the intended user. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "authentication", "version": "1.0" }, "servers": [ { "url": "https://{OrangeLogicURL}/api/Authentication", "variables": { "OrangeLogicURL": { "default": "OrangeLogicURL" } } } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://example.com/oauth2/token", "scopes": {} } } } } }, "security": [ { "sec0": [] } ], "paths": { "/v2.0/Login": { "post": { "summary": "User login", "description": "Obtain a login token", "operationId": "user-login", "parameters": [ { "name": "Token", "in": "header", "description": "An authentication token. If empty, the token included in the current cookie is used.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "Login", "Password", "format" ], "properties": { "Login": { "type": "string", "description": "The user’s email or Login ID" }, "Password": { "type": "string", "description": "The user’s password" }, "format": { "type": "string", "description": "The response format (XML or JSON)", "default": "XML" }, "IncludeUserEmail": { "type": "boolean", "description": "Whether the response includes the user’s email", "default": false }, "dateformat": { "type": "string", "description": "The output date format", "default": "yyyy-MM-ddTHH:mm:ss" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"APIRequestInfo\": {\n \"ProviderVersion\": \"LONDON.R2.2131E.216729\",\n \"ProviderIdentity\": \"CUY-T-USW2-APP\",\n \"ProviderID\": \"73777eae05c8592d0a349f5fa680ecb3\",\n \"Module\": \"Authentication\",\n \"APIVersion\": \"v2.0\",\n \"Resource\": \"Login\",\n \"IsLoggedIn\": true,\n \"Status\": \"LoggedIn\",\n \"UserLogin\": \"KristenHarrison\",\n \"Session\": \"No session (production configuration)\",\n \"TimeoutPeriodMinutes\": 20\n },\n \"APIResponse\": {\n \"RequestInterpretation\": {\n \"ParametersInformation\": {\n \"Login\": {\n \"Value\": \"KristenHarrison\",\n \"IsOptional\": false,\n \"ValueCount\": 1\n },\n \"Password\": {\n \"Value\": \"***hidden***\",\n \"IsOptional\": false,\n \"ValueCount\": 1\n },\n \"IncludeUserEmail\": {\n \"Value\": \"false\",\n \"IsOptional\": true,\n \"ValueCount\": 1\n }\n }\n },\n \"Response\": {\n \"Code\": \"SUCCESS\",\n \"Token\": \"CortexKQBIFTIQDMF8rTjO6XDkvHL.eiV7j3qcLZLazpakbNoKXxgLWTDDNuzlfTzy2U38\"\n },\n \"ExecutionStatus\": \"Executed\",\n \"HTTPCode\": 202,\n \"Code\": \"SUCCESS\"\n }\n}" } }, "schema": { "type": "object", "properties": { "APIRequestInfo": { "type": "object", "properties": { "ProviderVersion": { "type": "string", "example": "LONDON.R2.2131E.216729" }, "ProviderIdentity": { "type": "string", "example": "CUY-T-USW2-APP" }, "ProviderID": { "type": "string", "example": "73777eae05c8592d0a349f5fa680ecb3" }, "Module": { "type": "string", "example": "Authentication" }, "APIVersion": { "type": "string", "example": "v2.0" }, "Resource": { "type": "string", "example": "Login" }, "IsLoggedIn": { "type": "boolean", "example": true, "default": true }, "Status": { "type": "string", "example": "LoggedIn" }, "UserLogin": { "type": "string", "example": "KristenHarrison" }, "Session": { "type": "string", "example": "No session (production configuration)" }, "TimeoutPeriodMinutes": { "type": "integer", "example": 20, "default": 0 } } }, "APIResponse": { "type": "object", "properties": { "RequestInterpretation": { "type": "object", "properties": { "ParametersInformation": { "type": "object", "properties": { "Login": { "type": "object", "properties": { "Value": { "type": "string", "example": "KristenHarrison" }, "IsOptional": { "type": "boolean", "example": false, "default": true }, "ValueCount": { "type": "integer", "example": 1, "default": 0 } } }, "Password": { "type": "object", "properties": { "Value": { "type": "string", "example": "***hidden***" }, "IsOptional": { "type": "boolean", "example": false, "default": true }, "ValueCount": { "type": "integer", "example": 1, "default": 0 } } }, "IncludeUserEmail": { "type": "object", "properties": { "Value": { "type": "string", "example": "false" }, "IsOptional": { "type": "boolean", "example": true, "default": true }, "ValueCount": { "type": "integer", "example": 1, "default": 0 } } } } } } }, "Response": { "type": "object", "properties": { "Code": { "type": "string", "example": "SUCCESS" }, "Token": { "type": "string", "example": "CortexKQBIFTIQDMF8rTjO6XDkvHL.eiV7j3qcLZLazpakbNoKXxgLWTDDNuzlfTzy2U38" } } }, "ExecutionStatus": { "type": "string", "example": "Executed" }, "HTTPCode": { "type": "integer", "example": 202, "default": 0 }, "Code": { "type": "string", "example": "SUCCESS" } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true } ```