-
Notifications
You must be signed in to change notification settings - Fork 564
Get Authenticated User
Sayar Samanta edited this page Aug 28, 2018
·
4 revisions
Description : This api return the details of authenticated user
- URL : api/v1/authenticate/user
Parameters :
Name | Data Type | Required/Optional | Description |
---|---|---|---|
api_key |
String | Optional | An alphanumeric code that can be used to authenticate your API calls. To make it required login to Admin panel and go to API setting and make it mandatory |
token |
String | Required | token generated for a user |
HTTP Method : GET
Response Format : JSON
Response : Returns user details on success and error message on failure
JSON Response Example :
Success Response :
{
"user": {
"id": 1,
"user_name": "demoadmin",
"first_name": "Demo",
"last_name": "Admin",
"gender": 0,
"email": "mr.dmartin1984@gmail.com",
"ban": 0,
"active": 1,
"is_delete": 0,
"ext": "",
"country_code": 0,
"phone_number": "",
"mobile": null,
"agent_sign": "",
"account_type": "",
"account_status": "",
"assign_group": 1,
"primary_dpt": 1,
"agent_tzone": "",
"daylight_save": "",
"limit_access": "",
"directory_listing": "",
"vacation_mode": "",
"company": "",
"role": "admin",
"internal_note": "",
"profile_pic": "https://secure.gravatar.com/avatar/b4bfa60e2b38b40cf980d30da5f6373b?s=80&r=g&d=identicon",
"created_at": "2018-08-13 14:22:49",
"updated_at": "2018-08-13 14:23:14",
"user_language": null
}
}
Some Common Error :
Error Response : If the token is expired
{
“error":"Token has expired"
}
If the token is not provided
{
"success": false,
"message": "Token not provided"
}
Response Description :
Parameter | Description |
---|---|
id | id of the user |
user_name | user name of the user |
first_name | first name of the user |
last_name | last name of the user |
gender | gender of the user |
email of the user | |
ban | indicates if the user is banned or not |
active | indicates if the user is active or not |
is_delete | indicates if the user is deleted or not |
ext | indicates extension of the phone number |
country_code | indicates the country code of the user |
phone_number | phone number of the user |
mobile | mobile number of the user |
agent_sign | id of the user |
account_type | indicates the type of the user account |
account_status | indicates the status of the user account |
assign_group | indicates the group in which the user is assigned to |
primary_dpt | indicates the primary department of the user |
agent_tzone | indicates the time zone of the user |
daylight_save | id of the user |
limit_access | id of the user |
directory_listing | id of the user |
vacation_mode | id of the user |
company | indicates the company of the user |
role | indicates the role of the user |
internal_note | id of the user |
created_at | indicates when the user profile is created |
profile_pic | id of the user |
updated_at | indicates when the user profile is last updated |
user_language | indicates the user language |
Did you find it helpful? If not email us on support@faveohelpdesk.com
Installation and Upgrade Guide
- GUI Install Wizard
- Manual Install
- CLI Install
- Server Requirements
- Installation with Apache
- Installation with cPanel
- Cron Job or any Job scheduler
- Faveo Helpdesk Installation on CentOS 7 with Apache on PHP 7.1
- Faveo Helpdesk Installation on CentOS 7 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Apache on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Apache on PHP 7.1
- Migrating Faveo from one server to another
- Configuration of Redis with Faveo
- Install and configure Redis, Supervisor and Worker for Faveo on Ubuntu 16.04
- Install Let’s Encrypt SSL on CentOS 7 Running Apache Web Server
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Ubuntu 16.04 server
- Install and configure Redis, Supervisor and Worker for Faveo on Centos 7
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Centos 7 server
- Faveo Helpdesk Pro Installation on Windows Server 2012 R2
- Install Active Directory Domain Services in Windows Server 2012 R2
- Install Faveo Helpdesk Community on Centos, Ubuntu or Debian Using Script
- Set up automatic backup for Faveo-Helpdesk
Administrator's Guide
- Faveo File Storage
- Change client side theme color
- How to edit or change the footer in faveo
- How to change agent and admin panel Faveo logo link and logo
- Agents
- Departments
- Team
- Priority
- SLA
- Workflow
- Helptopic
- Default Ticket Settings
- Status
- Rating
- Close Ticket Workflow
- Company Settings
- Social Login
- Language
- Security
- Debugging/Logs
- Ban Emails
- Widgets
Agent's Guide
Email Integration
Release & Upgrade Notes
- General Faveo Upgrade Guide Manual
- General Faveo Upgrade Guide Auto
- Upgrade guide to v1.9.2
- Upgrade guide to v1.9.0
- How to update v1.0.7.9 to v1.0.8.0
- Manual Upgrade from v1.0.7.8 to v1.0.7.9
- Faveo Release notes & upgrade guide for V1.0.7.7
- Faveo Release notes & upgrade guide for V1.0.7.5
- Faveo Release notes & upgrade guide for V1.0.7
Known Issues
- The open_basedir restriction in effect
- 404 Not Found
- 500 Internal Server Error
- Bug after update from 1.0.7.4 to 1.0.7.5 or higher version
- Syntax error, unexpected ‘var’(T_VAR), expecting ‘;’
Contribute & Feedback
- Support the community edition
- Contribution Guide
- Faveo Feedback & Customisation
- Help in language translate
Knowledge Base
Third Party Integration
Plugins
API