LogoLogo
DocsSupportDashboard
  • Introduction
    • Data Types
    • Target Filtering
    • Scan Selection
    • Pagination & Sorting
    • Permissions
    • Appendix
  • Authentication
  • Webhooks
  • Events
  • Appendix
    • Targets Filter
    • Date Match
    • IP Range
  • Endpoints
    • Discovery
    • Target
    • Scan
    • Issue
    • Tag
    • Port
    • DNS
    • HTTP
    • Whois
    • Technology
    • Website
    • Acknowledged
    • Event
    • Dark Web
    • Integration
    • PCI
    • Report
    • User
    • Account
    • Security
    • File
    • Work
Powered by GitBook

© 2024 Halo Security

On this page
  • Get a list of users.
  • Get the details of a user.
  • Get the details of me.
  • Update the details of a user.
  • Invite a new user.

Was this helpful?

  1. Endpoints

User

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

PreviousReportNextAccount

Last updated 2 years ago

Was this helpful?

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

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

{
    "list": [
        {
            "role": 3,
            "user_id": 1,
            "phone": "1-000-000-0000",
            "last_name": "Doe",
            "title": "CEO",
            "first_name": "Jon",
            "email": "jon@example.com"
        }
    ]
}

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

Query Parameters

Name
Type
Description

user_id*

Integer

{
    "user": {
        "role": 3,
        "user_id": 1,
        "phone": "1-000-000-0000",
        "last_name": "Smith",
        "title": "CEO",
        "first_name": "Jon",
        "email": "jon@example.com"
    }
}
{
    "code": 0,
    "message": "user_id required"
}
{
    "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.

{
    "user": {
        "role": 1,
        "user_id": 1,
        "phone": "1-000-000-0000",
        "last_name": "Smith",
        "title": "CEO",
        "first_name": "Jon",
        "email": "jon@example.com"
    }
}

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

Query Parameters

Name
Type
Description

user_id*

Integer

first_name

String

last_name

String

title

String

phone

String

{
    "success": 1
}
{
    "code": 0,
    "message": "user_id required"
}
{
    "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

Query Parameters

Name
Type
Description

email*

String

role*

Integer

first_name

String

last_name

String

phone

Integer

{
    "success": 1
}
{
    "code": 0,
    "message": "email required"
}
{
    "code": 0,
    "message": "role required"
}
{
    "code": 0,
    "message": "email not valid"
}

https://www.halosecurity.com/user/account/users
https://www.halosecurity.com/user/account/users
https://www.halosecurity.com/user/account/users
https://www.halosecurity.com/user/account/users
https://www.halosecurity.com/user/account/add-user