Contents of this page

GET /user/index

Description

List User(s)

Endpoint

/user/index

Method

GET

Parameters

Name	Type	Required	Description
id	int	N	The User ID

POST /user/index

Description

Create User

Endpoint

/user/index

Method

POST

Parameters

Name	Type	Required	Description
first_name	string	Y	First name
last_name	string	Y	Last name
email	string	Y	Email
password_1	string	Y	Password Min length of 8 characters
password_2	string	Y	Repeat Password
user_groups	array	N	Array of User Group Id's

PUT /user/index

Description

Edit User

Endpoint

/user/index

Method

PUT

Parameters

Name	Type	Required	Description
id	int	Y	The User ID
first_name	string	Y	First name
last_name	string	Y	Last name
email	string	Y	Email
password_1	string	N	Password Min length of 8 characters
password_2	string	N	Required if password_1 is set.
user_groups	array	N	Array of User Group Id's

GET /user/current

Description

Get current User

Endpoint

/user/current

Method

GET

Response

{
    "response": {
        "status": "OK",
        "user": {
            "id": "1",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@flxone.com",
            "status": "1",
            "access_type": "api_and_interface"
        }
    }
}

PUT /user/password

Description

Change password

Endpoint

/user/password

Method

PUT

Request parameters

Name	Type	Required	Description
current_password	string	Y	The current password
new_password	string	Y	Minimum length of 8 characters.
new_password_confirm	string	Y	Same as 'new_password'

PUT /user/disable

Description

Disable User

Endpoint

/user/disable

Method

PUT

Parameters

Name	Type	Required	Description
id	int	Y	The User Id