Skip to content

Commit

Permalink
Create api-section.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guillermo-musumeci authored May 18, 2024
1 parent 6384456 commit a668c37
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions docs/settings/api-section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Enable/Disable API Sections
description: Enable/Disable API Sections
date: 2024-05-18
---

# Enable/Disable (Show/Hide) API Sections
[![KopiCloud_AD_API](https://img.shields.io/badge/kopiCloud_ad-v1.1+-blueviolet.svg)](https://adapi.kopicloud.com)

By default, all API sections are **enabled**, but you may need to disable sections for security reasons.

This article explains enabling or disabling some specific KopiCloud AD API sections.

API Section settings are managed by the file **C:\KopiCloud-AD-API\appsettings.json**.

This is the list of API settings that you can enable/disable:

- APIEnableAD
- APIEnableADComputer
- APIEnableADGroup
- APIEnableADGroupMembership
- APIEnableADUser
- APIEnableDNS
- APIEnableDnsA
- APIEnableDnsAAAA
- APIEnableDnsCNAME
- APIEnableDnsZones

----

## APIEnableAD

The **APIEnableAD** setting manages **ALL** Active Directory sections.

When you enable/disable this section, you will see/hide the **AD Computer**, **AD OU**, **AD User**, **AD Group**, and **ADGroupMembership** sections.

Open the **appsettings.json** file located at the root of the KopiCloud AD API folder (C:\KopiCloud-AD-API).

> AD Sections Enabled
```
"APIEnableAD: true"
```

> AD Sections Disabled
```
"APIEnableAD: false"
```

Save the file.

Restart the web server using the **IISReset command** or the IIS Console.

----

## APIEnableDNS

The **APIEnableDNS** setting manages **ALL** DNS sections.

When you enable/disable this section, you will see/hide the **APIEnableDnsA**, **APIEnableDnsAAAA**, **APIEnableDnsCNAME**, and **APIEnableDnsZones** sections.

Open the **appsettings.json** file located at the root of the KopiCloud AD API folder (C:\KopiCloud-AD-API).

> AD Sections Enabled
```
"APIEnableAD: true"
```

> AD Sections Disabled
```
"APIEnableAD: false"
```

Save the file.

Restart the web server using the **IISReset command** or the IIS Console.

0 comments on commit a668c37

Please sign in to comment.