# PEOPLE

Invoke the User API to retrieve User profile information.

## Get Current User Profile

 - [GET /user](https://api.tenovos.com/openapi/v1.5/people/getcurrentuser.md): Use this endpoint to get the user profile information for the account that you've authenticated against the Tenovos API with.  
This is useful when needing to check which groups you are in which may restrict the API calls you can make.

## Create User

 - [POST /user](https://api.tenovos.com/openapi/v1.5/people/createuser.md): Use this endpoint to create a new user account in the system.  You must have User Management role privilege and Security Template Management role privilege in order to create a user and assign groups.
This endpoint can be used to create local or federated users.

Average Response Time: 5140ms

## Get User Profile by ID

 - [GET /user/{id}](https://api.tenovos.com/openapi/v1.5/people/getuser.md): Current user will get its profile information in response.
User will also get ID of a role assign to him and a list of group IDs from which it belongs to.

Average Response Time: 154ms

## Update User Attributes

 - [PATCH /user/{id}](https://api.tenovos.com/openapi/v1.5/people/updateuser.md): Update User Profile attributes such as First Name, Last Name, Friendly Name, Email, Company, Country, Contact, Phone, and User Role. The user role can be updated by sending either role id or role name.

Average Response Time: 1587ms

## Add User to Group

 - [PATCH /user/{id}/add-to-group](https://api.tenovos.com/openapi/v1.5/people/addusertogroup.md): Assign a Security Group to a User Profile.

## Remove User from Group

 - [PATCH /user/{id}/remove-from-group](https://api.tenovos.com/openapi/v1.5/people/deletegroupfromuser.md): Remove an assigned Security Group from a User Profile.

## Search User Profiles (deprecated)

 - [GET /user/search/{searchText}](https://api.tenovos.com/openapi/v1.5/people/getuserbytext.md): Use this endpoint to retrieve a list of User Profiles matching the search keyword provided in the request parameter. Do not enter your search term wrapped in quotation marks.
Provided keyword will be matched against the user attributes case insensitively - First Name, Last Name, Friendly Name, Username, Email, Phone, Company, Contact, Country, Status, Group Names, and Role Name. Entering "*" as your search term will return all users.
The response is formatted as an area of objects, with each user account being returned as an object, as well as a key called 'count', which indicates how many accounts met the search critera. A maximum limit of 100 accounts will be returned in the response. 
In the case that more than 100 accounts meet the search criteria, pagination using the optional 'from' and 'limit' query parameters will be required to retrieve all accounts.

The user performing this action must have the 'User Management' role privilege.

How to use pagination:
Pagination should be used when the amount of user accounts that match the entered search term exceeds the amount of users (100) returned in a single response. Paginating through the results will require making more than one call to this endpoint.
To retrieve the first 100 users, in your query parameters, set your 'from' value to 0, and your 'limit' value to 100. To return the next set of 100 users, leave your 'limit' value as 100, but set your 'from' value to 100. 

Continue to repeat this process of adding 100 to your 'from' value until all user account results are captured.