Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Managing and Searching Users

This series of endpoints allows you to create users and assign roles. You may also use the search endpoints to find various accounts through various parameters such as email address, ID, or username.

User Accounts

Method   Description
POST /api/v2/users Create a User
DELETE /api/v2/users/{userId} Delete a User
POST /api/uploads/profile-image/{userId} Upload a User’s Profile Image
DELETE /api/uploads/profile-image/{userId} Delete a User’s Profile Image
GET /api/v2/users/roles List All Roles
GET /api/v2/users/session Get User Session
PATCH /api/v2/users/{userId} Patch User Data

User Search

Method   Description
GET /api/v2/search/access-entity Search Access Entity
GET /api/v2/users/{userId} Search for a User By UserID
GET /api/v2/users/{username}?type=username Search for a User By Username
GET /api/v2/users/{email}?type=email Search for a User By Email
GET /api/v2/search/groups/{groupId}/users List All User IDs Within a Specific Group