Minimal information about a Principal (User or Group). Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
name | data type | description |
---|---|---|
name | string | A unique name for the user or group. For users, this is the user's login name. |
email_address | string | The user or group's primary email address. |
Properties inherited from EntryBrief |
||
entry_type | string | The type of entry. Possible values are:
|
Properties inherited from DefinableEntityBrief |
||
permalinks | array of Link | |
creation | HistoryStamp | Date and time that the entity was created and the user who created it. |
entity_type | string | A string identifying the type of this entity. Possible values are user , group ,
folder , workspace and folderEntry . |
id | number | An ID for the entity. This is guaranteed to be unique for each entity type, but not necessarily unique among all entities.
For example, there will only be 1 user with an ID of 12, but there might also be a folder with an ID of 12. |
modification | HistoryStamp | The date and time when the entity was last modified and the user who modified it. |
parent_binder | ParentBinder | Information about the binder where this entity resides. |
title | string | The title or displayable name of the entity. |
description | Description | Description of the entity. For replies, this is the text of the comment. |
permalink | string | A URL in the web application for this entity. |
Properties inherited from SearchableObject |
||
doc_type | string | The indexed document type. Possible values are:
|
Properties inherited from BaseRestObject |
||
href | string | The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest). |
links | array of Link | Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs) |
Example
{ "name" : "...", "email_address" : "...", "entry_type" : "...", "permalinks" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ], "creation" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "entity_type" : "...", "id" : 12345, "modification" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "parent_binder" : { "path" : "...", "id" : 12345, "href" : "..." }, "title" : "...", "description" : { "text" : "...", "format_str" : "..." }, "permalink" : "...", "doc_type" : "...", "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }