Mage home pagelight logo
Routes
Sessions

​
Session object

{
  "expires": "2023-04-30 03:02:14.781970+00:00",
  "token": "...",
  "user": {
    "avatar": null,
    "first_name": null,
    "id": 1,
    "last_name": null,
    "owner": true,
    "roles": null,
    "roles_display": "Owner",
    "username": "admin"
  }
}
expiresrequired
datetime

The date and time the session is no longer valid.

tokenrequired
string

OAuth token used to authenticate each API request.

userrequired
object

Object containing variables for the pipeline.

​
Create session

POST /api/sessions

curl --request POST \
  --url http://localhost:6789/api/sessions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
  --data '{
  "session": {
    "email": "admin@admin.com",
    "password": "admin"
  }
}'

{
  "session": {
    "expires": "2023-04-30 03:02:14.781970+00:00",
    "token": "...",
    "user": {
      "avatar": null,
      "first_name": null,
      "id": 1,
      "last_name": null,
      "owner": true,
      "roles": null,
      "roles_display": "Owner",
      "username": "admin"
    }
  }
}