Identities

Identities are user accounts for your app or service. They make it easy to integrate a registration and login system into your app, and gives users the ability to create and manage their own data.

When a user registers an identity within your app and creates items, those items will be associated with that identity. Then, you can set up token permissions which allow identities to view and/or modify only their own items.

Identity object

{id: "268d32a7-7efc-417c-9777-3085ad022eba"
createdAt: "2026-09-05T11:30:27.872Z"
updatedAt: "2026-09-05T11:30:27.872Z"
user: {id: "6f933960-c18c-4ea1-b253-83d635a40d41"
createdAt: "2026-09-05T11:30:27.872Z"
updatedAt: "2026-09-05T11:30:27.872Z"
lastActiveAt: "2026-09-05T11:30:27.872Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample Identity"
group: "sample-group"
lastLoginAt: "2026-09-05T11:30:27.872Z"
activated: true
}

idstringUnique identifier for the identity.
createdAtstringDate and time the identity was created in ISO 8601 format.
updatedAtstringDate and time the identity was last updated in ISO 8601 format.
userobjectThe user who created the identity.
User attributes
- idstringUnique identifier for the user.
- createdAtstringDate and time the user registered in ISO 8601 format.
- updatedAtstringDate and time the user was last updated in ISO 8601 format.
- lastActiveAtstringDate and time the user was last active in ISO 8601 format.
- activatedbooleanWhether the user account is activated.
- displayNamestringThe user's display name.
- descriptionstringThe user's description.
namestringThe name of the identity. This also acts as the username for logging in.
groupstringIdentities can be grouped together. This allows you to have multiple identities with the same name, but scoped to different apps or projects.
activatedbooleanWhether the identity is activated. Inactive identities are not accessible via the API, and cannot login.

2024-12-07