Skip to main content
POST
/
session
Create session
curl --request POST \
  --url https://api-staging.pixwel.com/api/session \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_id": "58c6e38e4b161cef068b4576",
  "emailNormal": "jeff@pixwel.com",
  "invite": "https://platform.pixwel.com/register/:code",
  "name": "Jeff Loiselle",
  "password": "$2a$10$LVc.3fxRXOPkZHoQ.ZobGOVb1tj33w/RcMegpqwxQx5OeIRmn5Qhm",
  "preferences": {
    "blacklist": {
      "projects": [
        "<unknown>"
      ]
    },
    "mail": {
      "enabled": true,
      "projects": -1,
      "assets": -1,
      "files": -1,
      "work_requests": -1,
      "shares": 0,
      "ingest": -1,
      "offline_comments": -1,
      "others": 3600,
      "work_request_comments": -1,
      "workflow": -1
    },
    "ingest": {
      "skipScratchPreview": true,
      "maxUploads": 8
    },
    "contactLists": [
      {
        "name": "friends",
        "recipients": {
          "groups": [
            "<unknown>"
          ],
          "users": [
            "537b4984d86a1547348b4576"
          ]
        }
      }
    ],
    "reports": {
      "workRequests": {
        "dashboard": [
          {
            "i": "timeline",
            "x": 0,
            "y": 0,
            "w": 12,
            "h": 2
          }
        ],
        "hiddenCharts": [
          "map"
        ]
      }
    },
    "agent": {
      "instructions": ""
    }
  },
  "queue": [
    "<unknown>"
  ],
  "status": {
    "invited": true,
    "approved": true,
    "registered": true,
    "confirmed": true
  },
  "territory": {
    "_id": "51e149cdd5cddce641000048",
    "name": "United States",
    "code": "US",
    "standard": "NTSC",
    "countries": [
      {
        "name": "United States",
        "code": "US"
      }
    ],
    "languages": [
      {
        "name": "English",
        "code": "ENG",
        "dcpCode": "EN"
      }
    ],
    "assignedLanguages": [
      "586e6e83773dd6a60b56b3c0"
    ]
  },
  "username": "jeff@pixwel.com",
  "orderQueue": [
    "<unknown>"
  ],
  "shareQueue": [
    "<unknown>"
  ],
  "id": "58c6e38e4b161cef068b4576",
  "flags": [
    "<unknown>"
  ],
  "twofactorVerified": false,
  "permissions": [
    "<unknown>"
  ],
  "groups": [
    {
      "_id": "5328d77467d621906d8b4574",
      "addresses": [
        {
          "name": "Home",
          "address": "115 S Fulton St",
          "city": "Mobile",
          "state": "AL",
          "postalCode": "36606",
          "country": "USA"
        }
      ],
      "name": "PIXWEL",
      "studios": [
        "<unknown>"
      ],
      "type": "a",
      "users": [
        "53309f8367d621e6708b4568"
      ]
    }
  ],
  "roles": [
    "a"
  ],
  "studios": [
    "<unknown>"
  ],
  "$links": {
    "self": "//api-staging.pixwel.com/api/Users/58c6e38e4b161cef068b4576"
  },
  "hasEnforced2fa": false
}
'
{
  "_id": "58c6e38e4b161cef068b4576",
  "emailNormal": "jeff@pixwel.com",
  "invite": "https://platform.pixwel.com/register/:code",
  "name": "Jeff Loiselle",
  "password": "$2a$10$LVc.3fxRXOPkZHoQ.ZobGOVb1tj33w/RcMegpqwxQx5OeIRmn5Qhm",
  "preferences": {
    "blacklist": {
      "projects": [
        "<unknown>"
      ]
    },
    "mail": {
      "enabled": true,
      "projects": -1,
      "assets": -1,
      "files": -1,
      "work_requests": -1,
      "shares": 0,
      "ingest": -1,
      "offline_comments": -1,
      "others": 3600,
      "work_request_comments": -1,
      "workflow": -1
    },
    "ingest": {
      "skipScratchPreview": true,
      "maxUploads": 8
    },
    "contactLists": [
      {
        "name": "friends",
        "recipients": {
          "groups": [
            "<unknown>"
          ],
          "users": [
            "537b4984d86a1547348b4576"
          ]
        }
      }
    ],
    "reports": {
      "workRequests": {
        "dashboard": [
          {
            "i": "timeline",
            "x": 0,
            "y": 0,
            "w": 12,
            "h": 2
          }
        ],
        "hiddenCharts": [
          "map"
        ]
      }
    },
    "agent": {
      "instructions": ""
    }
  },
  "queue": [
    "<unknown>"
  ],
  "status": {
    "invited": true,
    "approved": true,
    "registered": true,
    "confirmed": true
  },
  "territory": {
    "_id": "51e149cdd5cddce641000048",
    "name": "United States",
    "code": "US",
    "standard": "NTSC",
    "countries": [
      {
        "name": "United States",
        "code": "US"
      }
    ],
    "languages": [
      {
        "name": "English",
        "code": "ENG",
        "dcpCode": "EN"
      }
    ],
    "assignedLanguages": [
      "586e6e83773dd6a60b56b3c0"
    ]
  },
  "username": "jeff@pixwel.com",
  "orderQueue": [
    "<unknown>"
  ],
  "shareQueue": [
    "<unknown>"
  ],
  "id": "58c6e38e4b161cef068b4576",
  "flags": [
    "<unknown>"
  ],
  "twofactorVerified": false,
  "permissions": [
    "<unknown>"
  ],
  "groups": [
    {
      "_id": "5328d77467d621906d8b4574",
      "addresses": [
        {
          "name": "Home",
          "address": "115 S Fulton St",
          "city": "Mobile",
          "state": "AL",
          "postalCode": "36606",
          "country": "USA"
        }
      ],
      "name": "PIXWEL",
      "studios": [
        "<unknown>"
      ],
      "type": "a",
      "users": [
        "53309f8367d621e6708b4568"
      ]
    }
  ],
  "roles": [
    "a"
  ],
  "studios": [
    "<unknown>"
  ],
  "$links": {
    "self": "//api-staging.pixwel.com/api/Users/58c6e38e4b161cef068b4576"
  },
  "hasEnforced2fa": false
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
_id
string
Example:

"58c6e38e4b161cef068b4576"

​
emailNormal
string
Example:

"jeff@pixwel.com"

​
invite
string
Example:

"https://platform.pixwel.com/register/:code"

​
name
string
Example:

"Jeff Loiselle"

​
password
string
Example:

"$2a$10$LVc.3fxRXOPkZHoQ.ZobGOVb1tj33w/RcMegpqwxQx5OeIRmn5Qhm"

​
preferences
object
​
queue
any[]
​
status
object
​
territory
object
​
username
string
Example:

"jeff@pixwel.com"

​
orderQueue
any[]
​
shareQueue
any[]
​
id
string
Example:

"58c6e38e4b161cef068b4576"

​
flags
any[]
​
twofactorVerified
boolean
Example:

false

​
permissions
any[]
​
groups
object[]
​
roles
string[]
​
studios
any[]
​
$links
object
​
hasEnforced2fa
boolean
Example:

false

Response

200 - application/json

OK

​
_id
string
Example:

"58c6e38e4b161cef068b4576"

​
emailNormal
string
Example:

"jeff@pixwel.com"

​
invite
string
Example:

"https://platform.pixwel.com/register/:code"

​
name
string
Example:

"Jeff Loiselle"

​
password
string
Example:

"$2a$10$LVc.3fxRXOPkZHoQ.ZobGOVb1tj33w/RcMegpqwxQx5OeIRmn5Qhm"

​
preferences
object
​
queue
any[]
​
status
object
​
territory
object
​
username
string
Example:

"jeff@pixwel.com"

​
orderQueue
any[]
​
shareQueue
any[]
​
id
string
Example:

"58c6e38e4b161cef068b4576"

​
flags
any[]
​
twofactorVerified
boolean
Example:

false

​
permissions
any[]
​
groups
object[]
​
roles
string[]
​
studios
any[]
​
$links
object
​
hasEnforced2fa
boolean
Example:

false