LogoLogo
Get Demo
  • 💫NEXT-GENERATION PRODUCT
    • Introduction
    • Getting Started
      • 1. Invite System Users
      • 2. Add Target Users
        • Add Users via CSV
        • Add users via SCIM
          • SCIM Setup in Azure AD
          • SCIM Setup in Okta
          • SCIM Setup in Onelogin
          • SCIM Setup in Jumpcloud
        • Add users via LDAP
        • Add Users via API
      • 3. Email Deliverability
        • Microsoft 365
          • M365: Direct Email Creation
          • M365: Whitelisting
        • Google Workspace
          • Google: Direct Email Creation
          • Google: Whitelisting
        • Exchange 2013 and 2016
      • 4. Track Opened Emails
      • 5. Allow Phishing URLs
        • Whitelist for Office 365
        • Whitelist for Google Workspace
        • Whitelist for Exchange 2013/2016
        • Whitelist in Security Solutions
      • 6. Setup Phishing Reporter
        • Step 1. Download Phishing Reporter
        • Step 2. Deploy Phishing Reporter
          • How to Deploy Add-In in Microsoft 365
          • How to Deploy Add-In in Exchange Admin Center
          • How to Deploy Add-In in Google Workspace
          • How to Deploy Add-In in Outlook
            • Troubleshooting Phishing Reporter Add-In on Outlook Desktop
      • 7. Incident Responder Setup
        • Step 1. Integrate Threat Intel Partners
        • Step 2. Mail Configurations
          • Microsoft 365
          • Google Workspace (Gsuite)
          • Exchange (EWS)
    • Platform
      • Dashboard
        • Dashboard Widgets
        • Incident Responder Widgets
        • Threat Sharing Widgets
        • Phishing Simulator Widgets
      • Threat Intelligence
      • Email Threat Simulator
        • Start Scan
        • View Scan Report
        • Create Trusted Account on Exchange
        • Start Scan on O365 Email Account
        • Start Scan on Google Workspace Email Account
      • Threat Sharing
        • Communities
        • Incidents
      • Phishing Simulator
        • Manage Phishing Scenarios
          • Phishing Scenarios
          • Email Templates
          • Landing Pages
        • Phishing Campaign Manager
        • Phishing Campaign Reports
        • Settings
          • DNS Services and Domains
          • Exclude IP Address
      • Callback Simulator
        • Manage Callback Scenarios
          • Callback Scenarios
          • Callback Email Templates
          • Callback Templates
        • Callback Campaign Manager
        • Callback Campaign Reports
        • Settings
          • Callback Phone Numbers
      • Vishing Simulator
        • Vishing Templates
        • Vishing Campaign Manager
        • Vishing Campaign Reports
      • Smishing Simulator
        • Manage Smishing Scenarios
          • Smishing Scenarios
          • Text Message Templates
          • Landing Page Templates
        • Smishing Campaign Manager
        • Smishing Campaign Reports
        • Settings
          • Manage DNS and Domains
          • Exclude IP Addresses
      • Quishing Simulator
        • Manage Quishing Scenarios
          • Quishing Scenarios
          • Quishing Templates
          • Quishing Landing Page Templates
        • Quishing Campaign Manager
        • Quishing Campaign Reports
        • Settings
          • DNS and Domains
          • Excluding IP Address
      • Awareness Educator
        • Training Library
        • Enrollments
        • Certificates
        • Training Reports
        • Training Completion Queries
      • Incident Responder
        • Incident Responder Dashboard
        • Investigations
        • Integrations
        • Playbook
        • Mail Configurations
          • Microsoft 365
          • Exchange
          • Google Workspace
        • Cross Company Integration
      • Phishing Reporter
        • Phishing Reporter Customization
        • Phishing Reporter Deployment
          • How to Deploy the Add-in in Microsoft 365
          • Phishing Reporter Page View Failure Due to Deprecated Exchange Online Tokens
          • Microsoft Ribbon Phishing Reporter
          • How to Deploy the Add-in in Exchange Admin Center
          • How to Deploy the Add-in in Google Workspace
          • Phishing Reporter Announcement Email Template
        • Diagnostic Tool
        • Integrating Microsoft Phishing Reporting Button with Keepnet
        • Troubleshooting Phishing Reporter on Outlook Desktop
      • Reports
        • Advanced Reports
        • Executive Reports
        • Scheduled Reports
        • Gamification Report
      • Company
        • Target Users
        • Companies
          • Company Groups
        • Company Settings
          • Privacy
            • Account Privacy
            • Data Privacy
          • AI Ally Settings
          • SMTP Settings
          • Direct Email Creation
            • Direct Email Creation for Google Workspace
            • Direct Email Creation for Microsoft 365
          • Notification Templates
          • Google User Provisioning
          • REST API
          • White Labeling
          • Proxy Settings
          • SAML Settings
            • How to Configure SAML on ADFS
            • How to Configure SAML on Google Workspace
            • How to Configure SAML on Azure AD
            • How to Configure SAML on CyberArk
            • How to Configure SAML on Okta
          • SCIM Settings
            • Getting Started with SCIM
            • Azure AD SCIM Integration
            • Okta SCIM Integration
            • Onelogin SCIM Integration
            • Jumpcloud SCIM Integration
          • SIEM Integrations
            • Splunk Integration
            • Syslog Integration
          • LDAP
          • Allowed Domains
        • System Users
          • People
          • Roles
        • Audit Log
        • Job Log
      • Free Phishing Email Analysis Service
    • Miscellaneous
      • Whitelisting
        • How to Whitelist an IP Address in Office 365
        • How to Whitelist an IP Address in Exchange 2013 and 2016
        • How to Whitelist an IP Address in Google Workspace
        • How to Whitelist in Mimecast
        • Whitelisting in Other Security Solutions
        • Whitelisting the Pictures on Microsoft Outlook Apps
        • Keepnet Tools Whitelisting Guidelines
        • Understanding Email Delivery Errors
        • Tracking Email Opens in Phishing Simulations
      • User Profile
      • Multi-Factor Authentication (MFA) Settings
      • On-Premise Requirement Checker
      • Platform Requirements
        • Portal UI Requirements
        • Phishing Reporter Requirements
        • Diagnostic Tool Requirements
      • Maintenance Tool
      • Understanding the Preferred Language Setting
  • 📚RESOURCES
    • Platform Security
    • Volume & Performance
    • Customer Help Desk
    • Product Update/Maintenance
    • Research Methodology
    • Release Notes
      • 2025
      • 2024
      • 2023
      • 2022
      • 2021
      • 2020
  • ⚖️Legal Hub
    • For Customers
      • Customer Terms of Service
      • Product Specific Terms
      • Jurisdiction Specific Terms
      • Data Processing Agreement
      • Regional Data Hosting Policy
      • Product and Services Catalog
      • Acceptable Use Policy
      • Keepnet Security Program
      • Microsoft CoPilot Usage Policy
    • For Everyone
      • Website
        • Terms of Use
        • Privacy Policy
        • Cookie Policy
      • Free Phishing Email Analysis
        • Terms of Service
        • Privacy Policy
      • Transparency Report
Powered by GitBook

Copyright © Keepnet Labs LTD. All rights reserved.

On this page
  • Why is REST API Needed?
  • REST API Page
  • How to Configure a REST API
  • Video Tutorial
  • Use Cases
  • Use Case 1: SOAR Integrations
  • Use Case 2: IAM - IDM Integration (​​User provisioning)
  • Use Case 3: Password Management
  • Use Case 4: SIEM Integration
  • FAQ
  • Q: I have an identity management (IDM) solution, can user provisioning be performed in real-time with the platform?
  • Q: How can I purposely expire a token so I can get a new one?
  • Q: Can I request token validity period when I initially request a token instead of getting a default validity period?
  • Q: What is the default token validity period?

Was this helpful?

Export as PDF
  1. NEXT-GENERATION PRODUCT
  2. Platform
  3. Company
  4. Company Settings

REST API

Why is REST API Needed?

This section explains the potential benefits available with the use of a REST API.

REST API allows you to configure the integration between the platform and other products, export all the data you see on the platform and add data to the platform with supported API requests. A REST API configuration will enable you to efficiently run and manage almost every function on the product off-platform.

REST API Page

You can view, edit, or delete any API configurations at the Company > Company Settings > Rest API page.

Client Name

The REST API settings' name.

API Key

The API Key that belongs to the related REST API setting.

Status

The status can be set to inactive to not to use Rest API anymore.

Date Created

The date and time that REST API settings’ were created.

Action

REST API settings’ can be edited or deleted.

How to Configure a REST API

Go to Company > Company Settings > REST API from the platform menu. Then click the + NEW button to create a new REST API. The components of the REST API edit page are explained in detail in the table below.

Client Name

Name of the REST API configuration

Generate Client Credentials

Create Client ID and Client Secret keys by clicking the button

Client ID

Client ID key information

Client Secret

Client Secret key information

The secret key is only displayed at the time of creation. This information must be copied and saved in a safe place at this stage.

IP Restriction

You can limit access to the REST API with the Client ID and Client Secret information based on IP address.

Allow all IPs = Any IP address can have the access to use Rest API.

Restrict access by IP address = Only permitted IP addresses will have access to the REST API. You may add additional IP addresses if needed by clicking Add IP Address button.

Client Role

The standard roles are Reseller or Company Admin to access the API endpoints with the chosen role’s privilege.

Status

The status can be set to Inactive to not to use Rest API anymore.

Video Tutorial

This tutorial explains the potential benefits available with the use of a REST API.

Use Cases

Use the address below to access the Swagger interface and authorize with client_id and client_secret information in order to use the endpoints, as described in these use case scenarios.

Use Case 1: SOAR Integrations

API integration with your security orchestration, automation, and response (SOAR) solutions enables you to respond more efficiently to harmful emails.

Use Case 2: IAM - IDM Integration (​​User provisioning)

Identity and access management is critical to success; however, manually uploading target user information to the platform is a laborious, time-consuming process. I Using the platform's API pool makes it possible to automatically perform tasks such as creating, updating, or deleting a target user.

Use Case 3: Password Management

The passwords of the system users registered with the platform must be changed at designated intervals. If your company does not support SAML integration, system users' passwords can be changed periodically using the platform's API pool.

Use Case 4: SIEM Integration

The actions of all system admin users and service accounts on the platform are recorded in audit logs for auditability and accountability.

You can transfer the audit logs to your SIEM product in real-time to manage and see audit logs on the SIEM product. You can either do it with REST API or from the Web Interface.

FAQ

Q: I have an identity management (IDM) solution, can user provisioning be performed in real-time with the platform?

A: Yes. The API Target User can facilitate secure and effortless management of user information. You can find additional information on the API documentation.

Q: How can I purposely expire a token so I can get a new one?

A: No, you can't expire the token. You can create as many token sessions as you want.

Q: Can I request token validity period when I initially request a token instead of getting a default validity period?

A: No, you can't change the validity period of the token.

Q: What is the default token validity period?

A: It is 24hr.

PreviousGoogle User ProvisioningNextWhite Labeling

Last updated 6 months ago

Was this helpful?

You may create and define a custom with custom privileges.

If the API endpoints are integrated with your current SOAR products, such as antivirus, firewall, endpoint detection, and response, proxy services, etc., it will save valuable time in the response to a potential threat via API endpoints in comparison with a manual investigation of a reported email.

💫
Incident Responder
role
LogoKeepnet Labs API
API Documentation