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 91

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. ResponseMessage is True when the address is free and False when a user already has it; ResponseData echoes the address.
DELETE Delete User /api/users/{UserID} Delete a user account, deleting the user's content or reassigning it to the anonymous user. ResponseData is true when the account was deleted; ResponseMessage carries the resulting status, or a content-does-not-exist message when no user has that ID.
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 Reset a user's profile photo to the default image. ResponseData is the URL of the default image now shown for the user.
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. ResponseData carries Records (sorted by last name), TotalRecords, NoOfPages, and IsCaptchaEnabledForPrivateMessage.
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. The response is the bare list of org chart users, not the response envelope.
GET Get Profile Fields /api/contenttype/fields/{EntityTypeID} Gets a list of profile fields. The code marks this route obsolete in favour of api/contenttype/{ContentTypeID}/fields, which returns the same 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. A caller who cannot view profiles, or a user whose profile is not public, comes back with a reduced set of fields (name, avatar, and profile URL).
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.
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.
GET Get User Profile Fields /api/content/{UserID} Enables administrators and developers to programmatically retrieve user profile fields for a particular user.
POST Issue Auth Token /api/public/users/auth-token/issue Part of the Axero JWT auth-token API . Exchanges a user name and password for a short-lived access token and a longer-lived refresh token.
POST Refresh Auth Token /api/public/users/auth-token/refresh Part of the Axero JWT auth-token API . Exchanges a valid refresh token for a new access token and refresh token, without sending the password again.
GET Search Users /api/users Get a list of users, filtered by status, role, department, email setting, or when the profile last changed.
POST Set Multiple Profile Fields Visibility /api/content/fields/visibilitymultiple Sets the visibility of multiple profile fields in a single API call. ResponseData is true; the body is a JSON object, and an empty object changes nothing, so a request without any field answers 200 and changes nothing.
POST Set Profile Field Visibility /api/content/fields/visibility Sets the visibility of a profile field for a specific user. ResponseData is true; the user's search index entry is refreshed afterwards.
PUT Update User and Multiple Users /api/users/{UserID} Update a user's core account properties. Only core user properties are supported.
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 Update a user's profile fields by their labels, or create the user when no match exists. This method also supports user preferences fields.
PUT Update User Status /api/users/status Ban, unban, activate, deactivate, or delete one or more user accounts. ResponseData is true when the last account acted on was updated.

Common Tasks

Provision users from another system

The path an HR or directory integration takes, with the endpoint for each step.

  1. Check that the address is free with Check User Email Availability. ResponseMessage is True when it is.
  2. Create the account with Add User. Core fields only; profile fields come next.
  3. Fill the profile with Update User Profile Fields, which addresses fields by their labels, and set who can see each field with Set Profile Field Visibility or Set Multiple Profile Fields Visibility.
  4. Find the account again later by Get User by Username, Search Users (by status, role, or when the profile last changed), or Get Filtered List of Users (by profile field values).
  5. Change core details with Update User and Multiple Users. Sending ReassignOption in the query string on that route selects the delete action instead, so keep the two calls apart.
  6. When someone leaves, deactivate with Update User Status if you may need the account back, or remove it with Delete User and Reassign Content so their content stays attributed to someone.

Act as a specific user

An integration that must read or write as one person rather than as the integration account gets a token for that user with Get Bearer Token for User and sends it on the calls that need it. Treat that token like a password: it acts as the user until it is revoked.

Wiki Index

Pages