Create an identity

Create a new identity.

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

Example

123456789

curl https://api.jsonpad.io/identities \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "group": "sample-group",
        "name": "Sample Identity",
        "password": "correct-horse",
        "activated": true
      }'

Parameters

No parameters

Request headers

required
x-api-tokenstringYour API token.

Request body

{group: "sample-group"
name: "Sample Identity"
displayName: "Sample Display Name"
tags: [0: "my-app"
]
email: "identity@example.com"
password: "correct-horse"
activated: true
}

optional
groupstringThe identity's group. This can be used to associate identities with a particular app or project, and helps to avoid name conflicts.
required
namestringThe name of the identity. Also used as the identity's login name.
optional
displayNamestringA public name for the identity, e.g. to show who created an item. Unlike the name, this isn't used for logging in.
optional
tagsstring[]
Tags for grouping related resources together, e.g. ["recipe-app", "production"].
Tags are stored lowercase and can only contain letters, numbers, hyphens and underscores. There can be up to 20 tags, each up to 50 characters long.
Setting tags replaces all of the existing tags, and an empty array removes them.
optional
emailstring | null
The identity's email address. Email addresses are unique within a group (ignoring case), and can be used instead of the name to log in. Required if the identity's group requires an email address.
In user auth mode you can also set emailVerified to true. Email addresses aren't included in responses in token auth mode.
required
passwordstring
The identity's password. This is used when logging in.
New passwords must be at least 8 characters, and at most 72 bytes, long.
The password will be encrypted before being stored in the database.
Also, passwords are always redacted from events and other logs.
optional
activatedbooleanWhether the identity is activated. Inactive identities cannot login and are not accessible via the API.

Response body

201 Created

{id: "f7877cb9-9169-499b-a20f-fafaf1bb58f7"
createdAt: "2026-09-23T21:08:40.230Z"
updatedAt: "2026-09-23T21:08:40.230Z"
user: {id: "3d9e060a-b049-48d8-b1eb-41f8201eec8c"
createdAt: "2026-09-23T21:08:40.230Z"
updatedAt: "2026-09-23T21:08:40.230Z"
lastActiveAt: "2026-09-23T21:08:40.230Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
group: "sample-group"
name: "Sample Identity"
displayName: "Sample Display Name"
tags: [0: "my-app"
]
activated: true
}

Response headers

locationhttps://api.jsonpad.io/identities/064256b8-987d-44b4-9f53-59d7c5da43e1The URL of the newly created identity.
last-modified2026-09-23T21:08:40.230ZThe date this identity was last modified.

2026-09-17