User
The User endpoint provides methods for retrieving and updating information related to your account, as well as inviting new users.
Last updated
Was this helpful?
The User endpoint provides methods for retrieving and updating information related to your account, as well as inviting new users.
Last updated
Was this helpful?
GET
https://api.halosecurity.com/api/v1/user/list.json
Returns a paginated list of users. Requires account_user
permission.
Learn about permissions: Permissions
sort
Integer
0
= email (default)
sort_desc
Integer
0
= No (default)
1
= Yes
String
Filter by email
name
String
Filter by name
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
user_id*
Integer
GET
https://api.halosecurity.com/api/v1/user/me.json
Returns the details of me.
GET
https://api.halosecurity.com/api/v1/user/update.json
If not me
, requires account_user
permission.
Learn about permissions: Permissions
user_id*
Integer
first_name
String
last_name
String
title
String
phone
String
GET
https://api.halosecurity.com/api/v1/user/invite.json
Requires account_user
permission.
Learn about permissions: Permissions
email*
String
role*
Integer
first_name
String
last_name
String
phone
Integer