Connect REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
User Summary
The User Summary response body is a subset of the User Detail response
body.
| Property | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| additionalLabel | String | If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” | Small, 30.0 | 30.0 |
| communityNickname | String | User’s nickname in the site. | Medium, 32.0 | 32.0 |
| companyName | String | Name of the company. | Small, 29.0 | 23.0 |
| displayName | String | User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. | Small, 32.0 | 32.0 |
| firstName | String | User's first name. In version 39.0 and later, if nicknames are enabled, firstName is null. | Small, 29.0 | 23.0 |
| id | String | 18-character ID of the user. | Small, 29.0 | 23.0 |
| isActive | Boolean | true if user is active, false otherwise. | Small, 29.0 | 25.0 |
| isChatterGuest | Boolean |
true if user is a Chatter customer, false otherwise In version 26.0 and later, user the userType property. |
23.0–26.0 | |
| isInThisCommunity | Boolean | true if the user is in the same Experience Cloud site as the context user; false otherwise. Can be false for record feed @mentions on posts with the scope “All Users.” | Small, 29.0 | 28.0 |
| lastName | String | User's last name. In version 39.0 and later, if nicknames are enabled, lastName is null. | Small, 29.0 | 23.0 |
| motif | Motif | Small, medium, and large icons indicating that the object is a user. The motif
can also contain the object’s base color. The motif icon is not the user’s profile photo. |
Small, 29.0 | 27.0 |
| mySubscription | Reference | If the context user is following this user, contains information about the subscription, otherwise null. | Medium, 29.0 | 23.0 |
| name | String | Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, name is the nickname. | Small, 29.0 | 23.0 |
| outOfOffice | Out of Office | If one exists, extra out-of-office message for the user. | Small, 40.0 | 40.0 |
| photo | Photo | Information about the user's photo. | Small, 29.0 | 23.0 |
| reputation | Reputation | Reputation of the user in the Experience Cloud site, which is determined by the number of points earned from events and actions performed in the site. | Big, 32.0 | 32.0 |
| stamps | Stamp[] | Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. |
Small, 39.0 | 39.0–43.0 |
| title | String | Title of the user. | Small, 29.0 | 23.0 |
| type | String | Value is User. | Small, 29.0 | 23.0 |
| url | String | URL to the user's Chatter profile. | Small, 29.0 | 23.0 |
| userType | String | Type of user.
Valid values are:
|
Medium, 29.0 | 26.0 |