Skip to main content
MindTouch Success Center

User object (TCS)

The user object includes properties that describe an individual user. Properties include everything from the page's API URI to the page's visit count. 

user.active : Boolean

Tells whether the user is using the site at the time you make the call.

DekiScript Sample Output
user.active;
true

user.activityuri : uri

URI of a feed of the user's MindTouch search and page view activity.

DekiScript Sample Output
user.activityuri;
https://example.mindtouch.us/@api/deki/activity/3:09d886d1-723c-4c03-9915-0056f93d860a

user.admin : Boolean

Tells whether the user is an admin or not. This is set on the user page in the control panel.

DekiScript Sample Output
user.admin;
true

user.anonymous : Boolean

Tells whether the user is logged in or not.

DekiScript Sample Output
user.anonymous;
false

user.api : uri

URI to access an XML document of the user's information.

DekiScript Sample Output
user.api;
https://example.mindtouch.us/@api/deki/users/3

user.authtoken : str

The authorization token for the user.

DekiScript Sample Output
user.authtoken;
3_635436189827314020_769fdd6fd30ec7517dce3bc9c2dd678d1535114d9e8e99501097a242d6acf33a

user.comments : map

A list of all of the comments a user has added on all pages in the site. NOTE: This call may return a lengthy list if the user has added many comments.

DekiScript Sample Output
user.comments;
[
    {
        "author": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_User#%5B+1+%5D",
        "date": "Fri, 25 Jul 2014 19:29:16 GMT",
        "mime": "text\/plain; charset=utf-8",
        "number": 2,
        "page": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_Page#%5B+728+%5D",
        "text": "test comment",
        "uri": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_CommentUri#%5B+728,+2+%5D"
    },
    {
        "author": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_User#%5B+1+%5D",
        "date": "Fri, 25 Jul 2014 14:41:23 GMT",
        "mime": "text\/plain; charset=utf-8",
        "number": 1,
        "page": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_Page#%5B+728+%5D",
        "text": "This is a test comment",
        "uri": "local:\/\/388203e18e5ca9c418cde5885d1ac837\/deki\/$get_CommentUri#%5B+728,+1+%5D"
    }
]

user.displayname : str

The user's display name. This is identical to user.fullname, and is controlled by the user in the preferences page or by the admin on the user's page in the control panel.

DekiScript Sample Output
user.displayname;
Jon

user.email : str

The user's email address.

DekiScript Sample Output
user.email;
jsmith@example.com

user.emailhash : str

MD5 hash of the user's email address.

DekiScript Sample Output
user.emailhash;
765d64036cc8ec496f31dd0c242dbeca

user.feed : uri

URI to a publicly available feed of the user's MindTouch contributions.

DekiScript Sample Output
user.feed;
https://example.mindtouch.us/@api/deki/users/3/feed

user.fullname : str

The user's full name. This is identical to user.displayname, and is controlled by the user in the preferences page or by the admin on the users page in the control panel.

DekiScript Sample Output
user.fullname;
Jon

user.gravatar : uri

URI to the user's Gravatar image. When used in DekiScript, MindTouch will convert the URI and display the image on the page.

DekiScript Sample Output
user.gravatar;
sample_gravatar.jpg

user.groups : map

Contains a collection of admin-created groups that the user is a part of. These groups are created in the groups page in the control panel.

DekiScript Sample Output
user.groups;
{
    Administrators: {
        id: 1,
        name: "Administrators"
    }
}

user.homepage : map

The page object for the user's personal MindTouch page.

DekiScript Sample Output
user.homepage;
{
    api: "https://across.mindtouch.us/@api/deki/pages/689?redirects=0",
    author: "",
    comments: "",
    contents: "",
    date: "Wed, 29 Jan 2014 12:47:28 GMT",
    editsummary: "Page created, 0 words added",
    feed: "https://across.mindtouch.us/@api/deki/pages/689/feed?redirects=0",
    files: "",
    fronturi: "https://across.mindtouch.us/User:JonC",
    id: 689,
    ishidden: false,
    language: "en-US",
    mime: "application/x.deki0805+xml",
    name: "JonC",
    namespace: "User",
    namespaceuser: "",
    overview: "",
    parent: "",
    parents: "",
    path: "User:JonC",
    properties: "",
    rating: "",
    redirect: nil,
    revision: 1,
    revisions: "",
    subpageinfos: "",
    subpages: "",
    tags: "",
    talkuri: "https://across.mindtouch.us/User:JonC",
    text: "",
    timeuuid: "8285b000-88e3-11e3-80f0-8ca6113c58aa",
    title: "JonC",
    toc: "",
    unprefixedpath: "JonC",
    uri: "https://across.mindtouch.us/User:JonC",
    viewcount: "",
    xml: ""
}

user.id : num

The user's ID in MindTouch.

DekiScript Sample Output
user.id;
3

user.language : str

Deprecated. Previously returned the language code for the user, but this value can no longer be set and always matches the site's language code.

user.metrics : map

Contains a collection of metrics pertaining to the user, including a comment count, number of files added, number of pages created, number of pages edited, and number of ratings.

DekiScript Sample Output
user.metrics;
{
    comments: 4,
    "files-added": 1,
    "pages-created": 2,
    "pages-edited": 2,
    "ratings-down": 2,
    "ratings-up": 8
}

user.name : str

The user's username in MindTouch.

DekiScript Sample Output
user.name;
JonC

user.owner : Boolean

Tells whether the user is the owner of the site.

DekiScript Sample Output
user.owner;
false

user.properties : map

Data storage for each user.

DekiScript Sample Output
user.properties;
{}

user.seated : Boolean

Tells whether the user is a PRO member. This is set on the user page in the control panel.

DekiScript Sample Output
user.seated;
true

user.timezone : str

The timezone that the user is in, based off of GMT.

DekiScript Sample Output
user.timezone;
-04:00

user.unseated : Boolean

Tells whether the user is not a PRO member. This value is always the opposite of the user.seated value.

DekiScript Sample Output
user.unseated;
false

user.uri : uri

The user's personal MindTouch page.

DekiScript Sample Output
user.uri;
https://example.mindtouch.us/User:JonC
  • Was this article helpful?