Login an identity

Each login creates a new session, so an identity can be logged in on several devices at once. How long the token lasts depends on the identity's group. Deactivated and locked identities can't log in.

POST https://api.jsonpad.io/identities/login

Example

12345678

curl https://api.jsonpad.io/identities/login \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "group": "sample-group",
        "email": "identity@example.com",
        "password": "correct-horse"
      }'

Parameters

No parameters

Request headers

required
x-api-tokenstringYour API token.
optional
x-identity-tokenstringAn identity token.
optional
x-identity-groupstringAn identity group.

Request body

{group: "sample-group"
email: "identity@example.com"
password: "correct-horse"
}

optional
groupstringThe identity group.
optional
namestringThe name of the identity. Either name or email is required, but not both.
optional
emailstringThe identity's email address, instead of its name. Email addresses are compared ignoring case.
optional
passwordstring
The identity's password.

Response body

200 OK

{id: "8d91312c-ad12-447c-a30c-600330ccd8f0"
createdAt: "2026-09-23T21:08:47.829Z"
updatedAt: "2026-09-23T21:08:47.829Z"
user: {id: "99f8e74e-93b1-4784-bdd1-5a4962c85f46"
createdAt: "2026-09-23T21:08:47.829Z"
updatedAt: "2026-09-23T21:08:47.829Z"
lastActiveAt: "2026-09-23T21:08:47.829Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample Identity"
displayName: "Sample Display Name"
email: "identity@example.com"
emailVerified: false
hasPassword: true
tags: [0: "my-app"
]
group: "sample-group"
token: "<IDENTITY TOKEN>"
activated: true
}

Response headers

No response headers

2026-09-17