sitemap.xml llms.txt
Skip to main content

Users

A user is someone who belongs to an Epicenter organization and can be a member of one or many groups, but doesn't have to. A new user has no group membership.

learn more

To manage users, call the functions of the User adapter.
To learn about user sessions and authentication, read the Authentication adapter reference.

Personal data​

To safeguard personal user data, all User adapter functions return a PseudonymReadOutView object.

A PseudonymReadOutView object has a detail property which can contain a UserReadOutView object with personal data of the user if it is available and if the requester has rights to access the data. Otherwise, detail is null.

Personal user data is deleted when the data retention limit is reached.

Display name​

The user entity contains a property called displayName. It's a good practice to allow you application users to set this name to the value of their choice allowing them to decide how they want their name to appear in the application UI.

Important

The displayName becomes null when Epicenter deletes personal data of the user.

User modality​

Modality is a sub-namespace for a user. Modality refers to how the user enters the application. The user handle is unique for the account and the modality.

By leveraging modality, project owners can treat a user who signs in via SSO as a new student each time the user joins a classroom.

Permissions​

The user permissions in Epicenter are determined by user roles. For specific role descriptions, read about the ROLE enum in the Developer reference.

Permits​

A permit in Epicenter is a combination of the readLock and writeLock properties. These properties are set to values of the ROLE enum.

A permit blocks access to an asset for any user with a role below that indicated by readLock or writeLock.

  • The readLock defines who can view information.
  • The writeLock defines who can update information.
important

For any entity, the readLock and writeLock roles cannot be higher than the role of the person creating the entity.

learn more

Permits are implemented with the Permit interface.

External and native users​

Users are identified as native or external based on the way they authenticate:

  • Native: authenticates using Epicenter handle and password.
  • External: authenticates through an external identity provider.