ApimaticsemgrepSDK 0.0.2

Getting Started with Semgrep Web App

Introduction

Welcome to Semgrep's portal for the Semgrep AppSec Platform web API.

Introduction

Semgrep is a fast, open-source, static analysis tool for finding bugs and enforcing code standards at editor, commit, and CI time. Get started.

This API is documented in the OpenAPI format.

Authentication

The API supports authentication with an API token with the "Web API" permission, without limited scopes of access.

You can provision an API token from the Settings page.

Terms of Use

Please note, the materials made available herein are subject to the Semgrep Terms of Use, and your access or use of any of the same is your acknowledgment and acceptance of the such terms.

<br>

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimaticsemgrepSDK --version 0.0.2

You can also view the package at: https://www.nuget.org/packages/ApimaticsemgrepSDK/0.0.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using SemgrepWebApp.Standard;
using SemgrepWebApp.Standard.Authentication;

namespace ConsoleApp;

SemgrepWebAppClient client = new SemgrepWebAppClient.Builder()
    .SemgrepAdminJwtCredentials(
        new SemgrepAdminJwtModel.Builder(
            "AccessToken"
        )
        .Build())
    .SemgrepJwtCredentials(
        new SemgrepJwtModel.Builder(
            "AccessToken"
        )
        .Build())
    .SemgrepWebTokenCredentials(
        new SemgrepWebTokenModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(SemgrepWebApp.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using SemgrepWebApp.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = SemgrepWebAppClient
    .FromConfiguration(configuration.GetSection("SemgrepWebApp"));

See the Configuration-Based Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• SemgrepAdminJWT (OAuth 2 Bearer token)
• SemgrepJWT (OAuth 2 Bearer token)
• SemgrepWebToken (OAuth 2 Bearer token)

List of APIs

• Deployments Service
• Findings Service
• Misc Service
• Policies Service
• Projects Service
• Scans Service
• Secrets Service
• Supply Chain Service
• Ticketing Service
• Triage Service

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter