User Login (V1)

get/login/extended

Authenticates a user. When the user is authenticated, the logged-in user's details (including all roles and permissions) are returned in the response body.

CSRF check is not performed by this endpoint, because the user is authenticated using the basic HTTP auth.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (User)
Array
lastName
string <= 255 characters
lastLogin
string <date-time>
typedId
string
firstLogin
boolean
noSession
boolean
Array of objects
customerFilterCriteria
string
defaultUserGroupViewDetails
string <= 255 characters
loginName
string <= 255 characters
allRoleNames
Array of strings
receiveAdminEmail
boolean
wizardDashboardName
string <= 255 characters
email
string <= 255 characters
createDate
string <date-time>
additionalInfo4
string <= 255 characters
additionalInfo3
string <= 255 characters
additionalInfo2
number
additionalInfo1
number
passwordExpiry
string
allGroups
Array of objects
Array of objects
productFilterCriteria
string
version
integer
ssoOnly
boolean
firstName
string <= 255 characters
defaultUserGroupEdit
string <= 255 characters
emailLocale
string <= 255 characters
workflowEmailingActivated
boolean
createdBy
integer
roleNames
Array of strings
requireTFA
boolean
activated
boolean
lastUpdateBy
integer
object
status
integer
Request samples
application/json
{ }
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "lastName": "string",
        • "lastLogin": "2019-08-24T14:15:22Z",
        • "typedId": "string",
        • "firstLogin": true,
        • "noSession": true,
        • "businessRoles": [
          ],
        • "customerFilterCriteria": "string",
        • "defaultUserGroupViewDetails": "string",
        • "loginName": "string",
        • "allRoleNames": [
          ],
        • "receiveAdminEmail": true,
        • "wizardDashboardName": "string",
        • "email": "string",
        • "createDate": "2019-08-24T14:15:22Z",
        • "additionalInfo4": "string",
        • "additionalInfo3": "string",
        • "additionalInfo2": 0,
        • "additionalInfo1": 0,
        • "passwordExpiry": "string",
        • "allGroups": [
          ],
        • "groups": [
          ],
        • "productFilterCriteria": "string",
        • "version": 0,
        • "ssoOnly": true,
        • "firstName": "string",
        • "defaultUserGroupEdit": "string",
        • "emailLocale": "string",
        • "workflowEmailingActivated": true,
        • "createdBy": 0,
        • "roleNames": [
          ],
        • "requireTFA": true,
        • "activated": true,
        • "lastUpdateBy": 0,
        • "extendedData": {
          }
        }
      ],
    • "status": 0
    }
}