User Management#
Although we highly recommend using the builtin user-management interface on {{BASE_URL}}, we also provide programmatic access to user-management features via REST API. The following section summarizes key terms and concepts behind our user management beyond the auto-generated API specification.
Realms vs. Customers vs. Users#
Users of natif.ai services (i.e. user-accounts that human users can authenticate for via email and password) are partitioned in the following ways:
Hint
In a sense, User accounts in many ways act as representatives of the Customer entity they are a part of.
Each User belongs to a Customer, as such Customers essentially represent Groups of Users that share certain resources, e.g.
- Stored Documents
- Annotation Projects
- Custom Workflows
- Pricing Model, Limits and Quotas
Each Customer belongs to exactly one Realm. Realms are basically overarching, isolated environments for Customers and Users. As a Reseller, you are eligible to manage all Customers and their Users within the borders of your own dedicated Realm, as well as inspect their meta-data, configurations and processing usage tracking.
A Realm is usually managed by Natif or by a Reseller. A reseller is a specific user within a customer. Reseller Users have to be created by Natif.