Phin Security

Phin Security API Routes & Information

The Phin Security public API provides various endpoints under the domain https://api.phinsec.io for partners to manage companies, users, reports, billing usage, and historical data, including routes for obtaining access tokens, testing connectivity, retrieving and editing company and user information, importing users, and accessing detailed reporting artifacts.

Supported API Routes

Below is a list of all supported routes for the Phin public API.

Routes

  • Get Access Token
    Method: POST
    Domain: https://phin.us.auth0.com
    Route: /oauth/token

  • Test
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/test

  • Get Companies in Phin
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/inventory

  • Get company in Phin
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId

  • Get Historical Data from a Company
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/historical-data

  • Get a list of Reporting Artifacts for a Company
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/reports

  • Get a specific report for a Company
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/report/:reportPath

  • Get usage for a Partner
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/billing/usage

  • Get usage for a Company
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/billing/usage

  • Get Users
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users

  • Edit Single User
    Method: PUT
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users/:userId

  • Bulk Edit Users
    Method: PUT
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users

  • Create a Company for a Partner
    Method: POST
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies

  • Import users into a Company
    Method: POST
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users/import

  • Sleep Users
    Method: PUT
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users/sleep

  • Delete Users
    Method: DELETE
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/users

  • Get User
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/user/:userId

  • Get Active Campaigns
    Method: GET
    Domain: https://api.phinsec.io
    Route: /partners/:partnerId/companies/:companyId/campaigns

Generic Errors

  • 400: You may be using the incorrect partnerId in the route or have disabled your Phin API Partner Integration.
  • 429: You are sending too many API requests. There are currently few limitations to using the API. However, API rate limiting per partner may be introduced in the future.