Users
Returns details for a specific user, such as username, display name, email address, and account status.
Table Specific Information
Select
The add-in will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in. You can also search for Attachments using CQL (Confluence Query Language).
- AccountId supports the '=,!=,IN,NOT IN' comparisons.
- PublicName supports the '=,LIKE,NOT LIKE' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Users WHERE AccountId = '1234'
SELECT * FROM Users WHERE AccountId IN ('1234', '2345')
SELECT * FROM Users WHERE PublicName = 'confluenceuser'
CQL
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Users WHERE CQL = 'user.userKey = "4028d6096b696826016b696960860000" AND type = user' AND UserName = 'currentUser()'
Columns
| Name | Type | References | SupportedOperators | Description |
| AccountId [KEY] | String | =,IN | The unique account identifier of the user. This column is available only for Confluence Cloud. | |
| AccountType | String | Specifies the type of user account, such as standard or external. This column is available only for Confluence Cloud. | ||
| PublicName | String | LIKE | The full public name of the user as displayed in Confluence. This column is available only for Confluence Cloud. | |
| String | The email address associated with the user's Confluence account. This column is available only for Confluence Cloud. | |||
| UserKey [KEY] | String | =,!=,IN,NOT_IN | The unique key identifying the user in Confluence Server. This column is available only for Confluence Server. | |
| UserName | String | = | The username used for login and identification in Confluence Server. This column is available only for Confluence Server. | |
| Status | String | Indicates the account status of the user, such as active, disabled, or pending. This column is available only for Confluence Server. | ||
| Type | String | Specifies the user type, such as internal user, external collaborator, or system account. | ||
| Excerpt | String | A short text summary or snippet of information related to the user. | ||
| ProfilePicturePath | String | The file path or URL to the user's profile picture. | ||
| ProfilePictureWidth | Integer | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Integer | The height, in pixels, of the user's profile picture. | ||
| IsDefaultPicture | Boolean | If the value is 'true', the profile picture has never been changed and remains the default system image. If the value is 'false', the user has uploaded a custom image. | ||
| DisplayName | String | The display name of the user as shown throughout Confluence, for example in comments, mentions, and activity streams. | ||
| Url | String | The URL to the user's profile page in Confluence. | ||
| LastModified | Datetime | The date and time when the user's profile information was last updated. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering users. |