Skip to content

Latest commit

 

History

History
44 lines (38 loc) · 1.73 KB

UserPublicSummary.md

File metadata and controls

44 lines (38 loc) · 1.73 KB
Raw

FlatApi::UserPublicSummary

Properties

Name Type Description Notes
id String The user unique identifier
type String The type of user account
product TutteoProduct [default to 'flat']
username String The user name (unique for the organization)
printable_name String The name that can be directly printed (name, firstname & lastname, or username) [optional]
firstname String Firstname of the user (for education users) [optional]
lastname String Lastname of the user (for education users) [optional]
name String A displayable name for the user (for consumer users) [optional]
picture String The URL of the picture to display
badges Array<String> List of badges for the user profile: - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge` [optional]
organization String Organization ID (for Edu users only) [optional]
organization_role OrganizationRoles [optional]
class_role ClassRoles [optional]
html_url String Link to user profile (for Indiv. users only) [optional]

Example

require 'flat_api'

instance = FlatApi::UserPublicSummary.new(
  id: null,
  type: null,
  product: null,
  username: null,
  printable_name: null,
  firstname: null,
  lastname: null,
  name: null,
  picture: null,
  badges: null,
  organization: null,
  organization_role: null,
  class_role: null,
  html_url: null
)