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://www.halosecurity.com/user/account/users
Query Parameters
Name | Type | Description |
---|---|---|
sort | Integer |
= email (default) |
sort_desc | Integer |
|
String | Filter by email | |
name | String | Filter by name |
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://www.halosecurity.com/user/account/users
Query Parameters
Name | Type | Description |
---|---|---|
user_id* | Integer |
Get the details of me.
GET
https://api.halosecurity.com/api/v1/user/me.json
Returns the details of me.
https://www.halosecurity.com/user/account/users
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://www.halosecurity.com/user/account/users
Query Parameters
Name | Type | Description |
---|---|---|
user_id* | Integer | |
first_name | String | |
last_name | String | |
title | String | |
phone | String |
Invite a new user.
GET
https://api.halosecurity.com/api/v1/user/invite.json
Requires account_user
permission.
Learn about permissions: Permissions
https://www.halosecurity.com/user/account/add-user
Query Parameters
Name | Type | Description |
---|---|---|
email* | String | |
role* | Integer | |
first_name | String | |
last_name | String | |
phone | Integer |
Last updated