Skip to content

Latest commit

聽

History

History
62 lines (53 loc) 路 4.26 KB

UserDetails.md

File metadata and controls

62 lines (53 loc) 路 4.26 KB

UserDetails

User details

Properties

Name Type Description Notes
id str The user unique identifier
type str The type of user account
product TutteoProduct [default to TutteoProduct.FLAT]
username str The user name (unique for the organization)
printable_name str The name that can be directly printed (name, firstname & lastname, or username) [optional]
firstname str Firstname of the user (for education users) [optional]
lastname str Lastname of the user (for education users) [optional]
name str A displayable name for the user (for consumer users) [optional]
picture str The URL of the picture to display
badges List[str] List of badges for the user profile: - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge` [optional]
organization str Organization ID (for Edu users only) [optional]
organization_role OrganizationRoles [optional]
class_role ClassRoles [optional]
html_url str Link to user profile (for Indiv. users only) [optional]
bio str User's biography [optional]
registration_date datetime Date the user signed up [optional]
liked_scores_count int Number of the scores liked by the user [optional]
followers_count int Number of followers the user has [optional]
following_count int Number of people the user follows [optional]
owned_public_scores_count int Number of public scores the user owns [optional]
all_public_scores_count int Total number of public scores the user participates in (owned + joined) [optional]
likes_count int Number of likes on the user published scores [optional]
plays_count int Number of plays on the user published scores [optional]
cover_picture str Cover picture (background) for the profile [optional]
profile_theme str Theme (background) for the profile [optional]
links UserCommunityProfileLinks [optional]
is_email_verified bool Whether the user's email address has been verified [optional]
azure_details UserAzureDetails [optional]
private_profile bool Whether this user profile is private (individual accounts only) [optional]
locale str The user language. Input values will be automatically normalized to a supported locale code. Unknown locales will default to `en`. Current supported locales include: `da`, `de`, `en`, `en-GB`, `es`, `fi`, `fil`, `fr`, `fr-CA`, `hi`, `id`, `it`, `ja`, `ja-HIRA`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pt-BR`, `ro`, `ru`, `sv`, `tr`, `zh-Hans`, `zh-HK`, `zh-TW` [optional] [default to 'en']
groups List[str] For Flat for Education accounts, list of Group identifiers the user is part of. [optional]
picture_file str The ID of the user profile picture [optional]
cover_picture_file str The ID of the user profile cover picture [optional]

Example

from flat_api.models.user_details import UserDetails

# TODO update the JSON string below
json = "{}"
# create an instance of UserDetails from a JSON string
user_details_instance = UserDetails.from_json(json)
# print the JSON string representation of the object
print(UserDetails.to_json())

# convert the object into a dict
user_details_dict = user_details_instance.to_dict()
# create an instance of UserDetails from a dict
user_details_from_dict = UserDetails.from_dict(user_details_dict)

[Back to Model list] [Back to API list] [Back to README]