User APIs
Overview 
OVERVIEW
Below is a quick overview of the Users API, more details can be found in the child pages.
| API | HTTP Request Type | HTTP Request URL | URL Parameters | HTTP Request content | HTTP Response |
| Get User | GET | /api/2/users/:user | :user = User ID OR User email | User Object of requested user | |
| Get User List | GET | /api/2/users?{params} | {params} = filters, sort, search, fields to return, etc | List of User summary Objects | |
| Add User | POST | /api/2/users | User object for new user | User summary Object of new user | |
| Add User profile image | POST | /api/2/users/:user/profileimage | :user = User ID OR User email | Image object (jpg, png, other accepted image formats) | User summary Object |
| Update User | PUT | /api/2/users/:user | :user = User ID OR User email | User object | User summary Object |
| Archive User | POST | /api/2/users/:user/archive | :user = User ID OR User email | User summary Object | |
| Activate User | POST | /api/2/users/:user/activate | :user = User ID OR User email | User summary Object | |
| Disable User | POST | /api/2/users/:user/disable | :user = User ID OR User email | User summary Object | |
| Get User System Preferences | GET | /api/2/users/:user/systempreferences | :user = User ID OR User email | Preferences Object for requested user | |
| Update User System Preferences | PUT | /api/2/users/:user/systempreferences | :user = User ID OR User email | Preferences object | User summary Object |
| Get User Email Preferences | GET | /api/2/users/:user/emailpreferences | :user = User ID OR User email | Email preferences Object for requested user | |
| Update User Email Preferences | PUT | /api/2/users/:user/emailpreferences | :user = User ID OR User email | Email preferences object | User summary Object |
| Bulk User Activate | POST | /api/2/users/activate | List of user emails or IDs | List of User summary Objects | |
| Bulk User Archive | POST | /api/2/users/archive | List of user emails or IDs | List of User summary Objects | |
| Bulk User Disable | POST | /api/2/users/disable | List of user emails or IDs | List of User summary Objects | |
| Assign/Revoke System Admin permissions | POST | /api/2/users/:user/sysadmin?{params} | {params} = action (assign/revoke) | User summary Object | |
| Assign/Revoke Key Contact | POST | /api/2/users/:user/keycontact?{params} | {params} = action (assign/revoke) | User summary Object | |
| Reinstate User | POST | /api/2/users/:user/reinstate | :user = User ID OR User email | User summary Object |
Update User System Preferences
Hi! Is there an API to send Invitations through Publisher? I know we can do it at the site level in Collaborate, but we'd like to invite our users to Publisher instead. Our users are getting created automatically, so being able to send an invitation automatically would be great. Thanks!
Last Updated: Nov 08,2024
Comments
1 Comments