Loading ...

REST API: Users | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 88

REST API: Users

0 
 /5
0 (0votes)
Open API Guide

Create, update, and manage user accounts programmatically. Handle profile data, profile field visibility, user status, authentication tokens, and integrate with external identity providers or HR systems.

Available Endpoints

Method Endpoint Description
POST Add User /api/users Add a new user to the intranet
PUT Add User Image /api/users/{UserID}/profile/image Add a profile photo for a user
GET Check User Email Availability /api/user/availability Check if an email address is available for use or not
DELETE Delete User /api/users/{UserID} Provides an automated mechanism for removing delete user data from the system.
PUT Delete User and Reassign Content /api/users/{UserID} Deletes a user specified by user ID, and re-assigns the content to another user. For more information about user deletion and content reassignment options, see Delete User.
DELETE Delete User Photo /api/users/{UserID}/photo Provides an automated mechanism for removing delete user photo data from the system.
PUT Feature User /api/users/feature Marks a user as featured or unfeatured on the site. Featured users are highlighted in people directories and widgets configured to display featured members.
GET Get Address /api/users/{UserID}/address/default Enables administrators and developers to programmatically retrieve a user's address.
GET Get All User Activity /api/users/activity Enables administrators and developers to programmatically retrieve user activity for all users.
GET Get Bearer Token for User /api/users/token Generate a JWT bearer token for a specific user to impersonate them in authenticated API requests
GET Get Direct Reports /api/users/{UserID}/directreports Get a list of people who report to a particular user.
GET Get Filtered List of Users /api/users Enables administrators and developers to programmatically retrieve a list of users filtered by profile fields.
GET Get Getting Started Steps Status /api/users/all/profilecomplete/status Gets the completion status of getting started steps for all users
GET Get Me /api/users/me Enables administrators and developers to programmatically retrieve your own profile details. This is the simplest way to get the logged-in user's data without needing to know their specific ID.
GET Get Online Users Count /api/users/online/count Enables administrators and developers to programmatically retrieve the number of users who are online.
GET Get Org Chart Users /api/orgchart/users Enables administrators and developers to programmatically retrieve org chart users starting at a specific user.
GET Get Profile Fields /api/contenttype/fields/{EntityTypeID} Gets a list of profile fields.
GET Get Upcoming Birthdays and Work Anniversaries /api/users/celebrations Enables administrators and developers to programmatically retrieve a list of users with upcoming birthdays and work anniversaries.
GET Get User /api/users/{UserID}/details Look up a user by their unique ID. This is the standard way to grab basic info for any community member. Use this when you have a UserID from another data source and need to show their name or profile picture quickly.
GET Get User Activity /api/users/{UserID}/statistics Get user activity for a certain user
GET Get User by Username /api/users/byusername/{username} Look up a user's full profile by their username. Useful when you have a handle from a comment, post, or mention but need the user's ID or profile data. Ideal for building user profile links with readable URLs.
GET Get User Profile Fields /api/content/{UserID} Enables administrators and developers to programmatically retrieve user profile fields for a particular user.
GET Search Users /api/users Enables administrators and developers to programmatically retrieve a list of users based on parameters.
POST Set Multiple Profile Fields Visibility /api/content/fields/visibilitymultiple Sets the visibility of multiple profile fields in a single API call.
POST Set Profile Field Visibility /api/content/fields/visibility Sets the visibility of a profile field for a specific user.
PUT Update User and Multiple Users /api/users/{UserID} Supports the synchronization and modification of delete user and reassign properties via the API.. Only core user properties are supported. Note: To update custom profile fields, use Update User Profile Fields (POST /api/users/fields) instead.
PUT Update User Points /api/user/{UserID}/points Facilitates the addition of or subtract points from a user. Points can be positive or negative but must be integers and cannot be decimal values.
POST Update User Profile Fields /api/users/fields Supports the synchronization and modification of add update user from fields properties via the API.. This method also supports user preferences fields.
PUT Update User Status /api/users/status Supports the synchronization and modification of update status properties via the API.

Wiki Index

Pages