Enclave.Sdk.Api

Provides a NuGet package that makes it easier to consume the Enclave Management APIs

Getting Started

Starting to use the API is simple; first you'll want to create a personal access token which can be done on the account page.

Creating an Enclave Client

When creating an Enclave client there are 3 ways to start. The first is to use a credentials.json file found in the .enclave folder in your user directory with the below structure.

{
    "personalAccessToken": "PERSONAL ACCESS TOKEN"
}

You then create a new EnclaveClient as below

var enclaveClient = new EnclaveClient();

Alternatively you can pass the EnclaveClient the personal access token directly, which overrides any value in your credentials file.

var token = "YOUR TOKEN";
var enclaveClient = new EnclaveClient(token);

Finally you can pass in an EnclaveClientOptions object

var enclaveClient = new EnclaveClient(new EnclaveClientOptions
{
    PersonalAccessToken = "YOUR TOKEN",
});

Selecting Your Organisation

Once you're authenticated you can then retrieve a list of orgs by calling the below block of code

// Retrieve all orgs associated to the authenticated User
var organisations = await enclaveClient.GetOrganisationsAsync();

// Select the org you want here we're just getting the first org
var organisation = organisations.FirstOrDefault();

// Create a client for the specified organisation.
var organisationClient = enclaveClient.CreateOrganisationClient(organisation);

Making an API Call

Making a call is really easy from the IOrganisationClient here you have access to all the API calls listed on the Enclave API Docs

To make an organisation call

var currentOrganisation = await organisationClient.GetAsync();

All other areas are properties on IOrganisationClient so for example

var enrolledSystems = await organisationClient.EnrolledSystems.GetSystemsAsync();

var enrolmentKey = await organisationClient.EnrolmentKeys.GetEnrolmentKeysAsync();

Update Requests

When updating an item, we make a call to the relevant Update method this then returns an instance of IPatchClient which has a fluent implementation. So for example;

var dnsZoneId = DnsZoneId.FromInt(123);
var result = await _dnsClient.UpdateZone(dnsZoneId).Set(d => d.Name, "New Name").ApplyAsync();