Get started
Public API
User management

User schema

User response schema:

Name Type Description
id string[uuid] Unique user identifier on the Masterplan side.
external_id string Unique user identifier on client side.
active bool Is user active.
emails list[Email] List of users emails (only one email per user is supported).
phoneNumbers list[PhoneNumber] List of users phone numbers (only one phone number per user is supported).
meta Meta Meta information for the user.
name Name User name.
userName string Human readable identifier of the user.
schemas list[string] List of strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.
roles list[string] List of user roles. Valid values are admin, owner, company_administrator, manager, student. Student role will be assigned to user during creation if not specified.
title string User title. Valid values are mr, ms, mx.
userType string User job title.
preferredLanguage string Preferred language by the user, specified as a two-letter language code. Masterplan is not storing all preferences, just parses the provided values and selects the supported language with the highest weight. If no value is provided, the server default will be used. Currently supported languages are: de, en, es, fr, it, cs, hu, pl, pt, and sk.
urn:masterplan:scim:UserAttributes MasterplanUserExtension MasterplanUserExtension Masterplan related user extensions.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User UserExtension UserExtension User extensions.

Email schema:

Name Type Description
value string User email address.
primary bool Is this the primary email. Currently ignored and set to true.
type string Type of email. Currently ignored and set to “work”.

PhoneNumber schema:

Name Type Description
value string User phone number.
primary bool Is this the primary phone number. Currently ignored and set to true.
type string Type of phone number. Currently ignored and set to “work”.

Name schema:

Name Type Description
familyName string User last name.
givenName string User first name.
PAGE CONTENT