User

The User endpoint provides methods for retrieving and updating information related to your account, as well as inviting new users.

Get a list of users.

GET https://api.halosecurity.com/api/v1/user/list.json

Returns a paginated list of users. Requires account_user permission.

Learn about permissions: Permissions

https://app.halosecurity.com/user/account/users

Query Parameters

Name	Type	Description
sort	Integer	0 = email (default)
sort_desc	Integer	0 = No (default) 1 = Yes
email	String	Filter by email
name	String	Filter by name

200: OK

{
    "list": [
        {
            "role": 3,
            "user_id": 1,
            "phone": "1-000-000-0000",
            "last_name": "Doe",
            "title": "CEO",
            "first_name": "Jon",
            "email": "[e-mail]"
        }
    ]
}

Get the details of a user.

GET https://api.halosecurity.com/api/v1/user/get.json

Returns the details of a user. If not me, requires account_user permission.

Learn about permissions: Permissions

https://app.halosecurity.com/user/account/users

Query Parameters

Name	Type	Description
user_id*	Integer

200: OK

{
    "user": {
        "role": 3,
        "user_id": 1,
        "phone": "1-000-000-0000",
        "last_name": "Smith",
        "title": "CEO",
        "first_name": "Jon",
        "email": "[e-mail]"
    }
}

400: Bad Request

{
    "code": 0,
    "message": "user_id required"
}

404: Not Found

{
    "code": 0,
    "message": "user not found"
}

Get the details of me.

GET https://api.halosecurity.com/api/v1/user/me.json

Returns the details of me.

https://app.halosecurity.com/user/account/users

200: OK

{
    "user": {
        "role": 1,
        "user_id": 1,
        "phone": "1-000-000-0000",
        "last_name": "Smith",
        "title": "CEO",
        "first_name": "Jon",
        "email": "[e-mail]"
    }
}

Update the details of a user.

GET https://api.halosecurity.com/api/v1/user/update.json

If not me, requires account_user permission.

Learn about permissions: Permissions

https://app.halosecurity.com/user/account/users

Query Parameters

Name	Type	Description
user_id*	Integer
first_name	String
last_name	String
title	String
phone	String

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "user_id required"
}

404: Not Found

{
    "code": 0,
    "message": "user not found"
}

Invite a new user.

GET https://api.halosecurity.com/api/v1/user/invite.json

Requires account_user permission.

Learn about permissions: Permissions

https://app.halosecurity.com/user/account/add-user

Query Parameters

Name	Type	Description
email*	String
role*	Integer
first_name	String
last_name	String
phone	Integer

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "email required"
}

400: Bad Request

{
    "code": 0,
    "message": "role required"
}

400: Bad Request

{
    "code": 0,
    "message": "email not valid"
}