User Attributes
Users in Frog have a standard set of attributes that are available through our APIs, to find out how these attributes are presented to your app, see sign on claims section.
Users matching or provisioning on the fly must be done with the user objects requested.
Attribute | Always available? | Description | Field Parameters | |
---|---|---|---|---|
FrogLearn User UUID |
Yes |
Unique identifier for each Frog user; will never change and is consistent across apps. Note: It is not possible for a user to move to a new organisation and keep the same Identity UUID - we recommend using FrogLearn User UUID + Organisation UUID as your primary identifier for a user. |
48 Character hexadecimal string |
|
|
Yes |
|
|
|
|
No |
First name of user (e.g. "John"). This is available for almost all users, but your application should cope with the attribute not being present or containing the empty string. |
|
|
|
Yes |
Note: We will use the user's preferred last name (if they have one) rather than their legal name. |
|
|
|
Yes |
"Student" - All learners associated with the institution. "Staff" - Any staff directly involved in teaching. "Parent" - These accounts are for parent contacts of students in the institution. Parent accounts have some subtle differences from other user types. "Other" - The bucket for users that do not fit into one of the above roles. This is at the discretion of the school's Frog administrator, but could include: prospective students, alumni, guests, temporary staff, or industry mentors. "Admin" - Used by school technicians and senior staff, these accounts have the ability to create other users. |
|
|
|
Yes |
|
|
|
|
No |
Note: This attribute is considered sensitive, so only request it if it's essential to deliver the functionality of your app. |
|
|
|
No |
|
|
|
|
Yes |
|
|
|
|
Yes |
|
|