2.1.1 User object extends Actor

Represents a user of the Drillster platform. Inherits from the 2.1.1 Actor object.

Example

{
  "type": "USER",
  "id": "RSOhvqHwSFKcetS6kTgCnQ",
  "name": "Phineas Flynn",
  "yearOfBirth": "2000",
  "avatar": {
    "type": "image/png",
    "url": "https://www.drillster.com/bin/avatar/05105d2b6585d1e1ee2b5491347375b95e2c623e"
  },
  "emailAddress": "thomas@drillster.com",
  "locale": "nl",
  "description": "Cartoon character.",
  "timeZone": "Europe/Amsterdam",
  "repertoireSize": 17,
  "organization": {
    "type": "ORGANIZATION",
    "id": "mHCCPnI-nPjYUn0upc8dIm7yzTIBgQ",
    "name": "Acme Corp",
    "locale": "en_US"
  },
  "created": "2010-03-12T15:47:31Z",
  "thirdPartyIds": [{
      "thirdParty": "ABC",
      "id": "123dzenab"
    }]
}

Fields

Field Type Description
type
required
String constant

The actor type. Always equal to USER. Inherited from Actor.

id
required
String

The unique ID of this user. Inherited from Actor.

Example value: RSOhvqHwSFKcetS6kTgCnQ

name
required
String

The user's name. Drillster does not separate first and last name. Inherited from Actor.

Example value: Phineas Flynn

avatar
optional
2.1.1 Media object

An avatar image representing the user. Inherited from Actor.

emailAddress
optional
String

The primary email address of the user. Inherited from Actor.

Example value: phineas@example.com

locale
optional
String

The preferred language of the user. If supported by Drillster, this language will be used if the user logs in to the web interface. If not provided, the calling user's locale will be used. The value must be a ISO 639-1 language code. Inherited from Actor.

Currently supported language codes by Drillster are:

  • en
  • es
  • fr
  • de
  • nl
  • pt
  • br
  • zh

Example value: fr

domicile
optional
String

An optional country code that reflects the domicile of this actor. This should be an upper case ISO 3166-1 country code. Inherited from Actor.

Example value: US or FR

lastLogin
optional
Timestamp

The last time the user logged in. Only shown where permitted by context. Absence of this field does not necessarily mean the user never logged in.

Example value: 2015-03-12T15:47:31Z

yearOfBirth
optional
String

The user's year of birth, if available and permitted to be shown.

Example value: 2000

description
optional
String

An optional description of the user.

timeZone
optional
String

The time zone that the user resides in. Values are as defined by the IANA Time Zone Database. This document provides a full list of time zone IDs.

Example values:

  • America/Los_Angeles
  • Europe/Amsterdam
  • Asia/Jakarta

quota
optional
Integer

The maximum number of lines that can be stored in the user's account. The only applies to basic accounts.

Example value: 500

repertoireSize
optional
Integer

The number of drills in the user's repertoire. Only included where permitted by content. Absence of this attribute does not necessarily mean the repertoire is empty.

organization
optional
2.1.1 Organization object

An optional organization of which this user is a staff member.

managingOrganization
optional
2.1.1 Organization object

An optional organization that manages this user (i.e. of which this user is a learner).

thirdPartyIds
optional
List of 2.1.1 ThirdPartyId objects

An optional list of third party IDs by which this user is also known.

created
optional
Timestamp

The date the user account was created.

Example value: 2010-03-12T15:47:31Z

creator
optional
2.1.1 ClientApp object

The API Client application that created this user account.

permissions
optional
2.1.1 Permissions object

An overview of the user's permissions.

passwordProtected
optional
Boolean

Whether the user has set a password for this account. If no password is set, the user is unable to authenticate using a password and can only log in through a third party.

person
optional
2.1.1 Person object

The person whom this account belongs to.