Using APIs

The platform REST APIs help you seamlessly integrate the platform with other solutions. To use the APIs, generate an access token.

You must have Organization Admin privileges to generate an access token.

Step 1: As an Organization Admin, click on the Settings icon on the top right corner of the navigation bar.

​

Step 2: Scroll down to the API Access Tokens section of the page and enter a name for the API Access Token and click on Generate. Take note of the token displayed in the modal window.

​

Step 3: You can access the API documentation for all APIs by clicking on the APIs documentation link.

Click on the API documentation (v2) as it is the most recent version.

The API documentation contains information on all of our available API endpoints.

1. Click on an API to see more details about it.
2. A description of the selected API will be displayed.
3. Next, you'll see the parameters associated with the API. In this case, no parameters are required.
4. You will also find the body of the selected API, where you can change the media type by selecting from the dropdown.
5. Finally, the responses of the API operation is shown, and you can adjust the media type using the available dropdown.

Using the API’s

There are two options to use the APIs.

Option 1

Option 2

Option 1

You can also download the Swagger file and use it in Postman. To do this, simply navigate to the management API web page and select Download Swagger JSON Definitions” Once downloaded, you can easily import the Swagger file into Postman for use.

Option 2

You can use a curl command on the terminal. Please look at the example below to call the 'technologies' API (replace YOURAPITOKEN
with your access token value):

curl -i -s -k -X $'GET' -H $'Host: api.secureflag.com' -H $'Authorization: Bearer YOURAPITOKEN' -H $'Content-type: application/json' $'https://api.secureflag.com/rest/management/technologies'

​​​

 

• Related Articles

• LMS and SCORM

  SecureFlag can integrate with existing LMS tools and environments using SCORM standards. You can use any of our existing learning paths, create your own custom learning paths, or combine multiple learning paths and download a single SCORM package to ...

• Reports

  Prudent, smart decisions rely on quality data. Our platform has built-in functionality allowing report generation with relevant data to assist you and your team to make the right decisions on your path to secure coding glory. The metrics that are ...

• Tournaments

  This feature is available exclusively on the Enterprise Plans. Learn more. A tournament offers an engaging and competitive way to promote awareness of secure coding. It adds excitement by allowing users to demonstrate the skills they have developed ...

• Threat Modeling SDK

  This feature is available exclusively on the Enterprise Plans. Learn more. This guide will walk you through using the Threat Model Software Development Kit (SDK), an innovative tool that enables you to build Threat Model labs that are both unique to ...

• Setting Assignment Strategy

  You can set assignment strategies for new users in your organization. There are four different assignment strategies available, and you can choose your preferred assignment from the ones below. Overview of Assignment Strategy: None: No activities ...