Skip to content

README.md

Latest commit

 

History

History
199 lines (161 loc) · 8.82 KB

README.md

File metadata and controls

199 lines (161 loc) · 8.82 KB

Devolutions.Pedm.Client - the C# library for the Devolutions PEDM API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version:
  • SDK version: 2025.5.15
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Devolutions.Pedm.Client.Api;
using Devolutions.Pedm.Client.Client;
using Devolutions.Pedm.Client.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Devolutions.Pedm.Client.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Connections

Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.

To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see here for details). To use your own HttpClient instance just pass it to the ApiClass constructor.

HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);

If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.

HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);

You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.

Here an example of DI setup in a sample web project:

services.AddHttpClient<YourApiClass>(httpClient =>
   new PetApi(httpClient));

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Devolutions.Pedm.Client.Api;
using Devolutions.Pedm.Client.Client;
using Devolutions.Pedm.Client.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new DefaultApi(httpClient, config, httpClientHandler);

            try
            {
                AboutData result = apiInstance.AboutGet();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.AboutGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DefaultApi AboutGet GET /about
DefaultApi ElevateSessionPost POST /elevate/session
DefaultApi ElevateTemporaryPost POST /elevate/temporary
DefaultApi LaunchPost POST /launch
DefaultApi LogJitGet GET /log/jit
DefaultApi LogJitIdGet GET /log/jit/{id}
DefaultApi PolicyAssignmentsGet GET /policy/assignments
DefaultApi PolicyAssignmentsIdPut PUT /policy/assignments/{id}
DefaultApi PolicyMeGet GET /policy/me
DefaultApi PolicyMePut PUT /policy/me
DefaultApi PolicyProfilesGet GET /policy/profiles
DefaultApi PolicyProfilesIdDelete DELETE /policy/profiles/{id}
DefaultApi PolicyProfilesIdGet GET /policy/profiles/{id}
DefaultApi PolicyProfilesIdPut PUT /policy/profiles/{id}
DefaultApi PolicyProfilesPost POST /policy/profiles
DefaultApi PolicyUsersGet GET /policy/users
DefaultApi RevokePost POST /revoke
DefaultApi StatusGet GET /status

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.