/
User

User

Contents of this page

GET /user/index

Description

List User(s)

Endpoint

/user/index

Method

GET

Parameters

NameTypeRequiredDescription
idintNThe User ID


POST /user/index

Description

Create User

Endpoint

/user/index

Method

POST

Parameters

NameTypeRequiredDescription
first_namestringYFirst name
last_namestringYLast name
emailstringYEmail
password_1stringY

Password
Min length of 8 characters

password_2stringYRepeat Password
user_groupsarrayNArray of User Group Id's


PUT /user/index

Description

Edit User

Endpoint

/user/index

Method

PUT

Parameters

NameTypeRequiredDescription
idintYThe User ID
first_namestringYFirst name
last_namestringYLast name
emailstringYEmail
password_1stringNPassword
Min length of 8 characters
password_2stringNRequired if password_1 is set.
user_groupsarrayNArray 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

NameTypeRequiredDescription
current_passwordstringYThe current password
new_passwordstringYMinimum length of 8 characters.
new_password_confirmstringYSame as 'new_password'


PUT /user/disable

Description

Disable User

Endpoint

/user/disable

Method

PUT

Parameters

NameTypeRequiredDescription
idintYThe User Id

Related content

Permission Filter
Permission Filter
More like this
Authentication
More like this
Segment
More like this
Audience Builder
Audience Builder
More like this
Permissions
More like this
Contextual Categories
Contextual Categories
More like this