User Types¶
A user type describes a mechanism to categorize users. It is not related to authentication or authorization and is used by applications to customize the user experience based on the type of the user.
User Types can be part of a system configuration for an application.
All User Types created by a user must be assigned to a specific application.
Property | Description |
---|---|
Key | String. Unique Key (within the application) . Required. |
ApplicationKey | String. Application.Key where this role is defined. Optional |
Name | String. Friendly name to refer the role. Required |
IsSystem | Boolean. Flags if this role is defined by the system or customized by the user. Required. System user types cannot be edited using the Security UI. Previously this field was named IsInternal |
How to manage user types¶
Roles can be managed from the API resource \Authentication\UserTypes
and also from Administration website (/applications/{ApplicationKey}/user-types
). Both offers the same functionality and are protected by securable Sec.UserType
.