Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Definition
https://www.yammer.com/api/v1/users/:user_id.json
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| user_id | path | integer | Add the user id specified by the numeric string. |
Documentation
Caution
User management should be performed through the Entra portal or Microsoft 365 admin center. This API remains available for a small number of legacy use cases. Review the latest admin documentation or open an M365 support case if you have questions on the recommended way to achieve this.
Suspension of users via this API can result in significant impact to Viva Engage usage as users must sign-in to reactivate their profile.
Deletion of users with the delete=true parameter is unrecoverable by the admin or Microsoft Support. In the vast majority of cases, deletion is not required.
Suspend or delete a user. Current user should be an admin or a verified admin in a paid Yammer network to perform this action.
Parameters:
The users API endpoints return a similar structure and support the following query parameters:
page - Programmatically paginate through the users in the network. 50 users will be shown per page.
letter - Return users with usernames beginning with the given character.
sort_by=[ messages | followers ] - Results will be returned sorted by number of messages or followers, instead of the default behavior of sorting alphabetically.
reverse=TRUE - Returns results in reverse order.
delete=TRUE - The DELETE method on a user resource will suspend that user’s account, allowing the user to reactivate through the website if they have access to a company email address. Passing delete=true along with the request will cause the account to be deleted, which cannot be undone by the user.
Parameters for creating or updating users:
email (required for creating a new user)
full_name
job_title
department_name
location
im_provider
im_username
work_telephone
work_extension
mobile_telephone
external_profiles
significant_other
kids_names
interests
summary
expertise
education[] (school,degree,description,start_year,end_year) - accepts multiple attributes i.e. education[]=UCLA,BS,Economics,1998,2002&education[]=USC,MBA,Finance,2002,2004
previous_companies[] (company,position,description,start_year,end_year) - accepts multiple attributes i.e. previous_companies[]=Geni.com,Engineer,2005,2008