Skip to content

Commit

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

# Enable/Disable (Show/Hide) API Sections
Expand All @@ -21,19 +21,19 @@ This is the list of API settings that you can enable/disable:
- APIEnableADGroupMembership
- APIEnableADUser
- APIEnableADOu
- APIEnableDNS
- APIEnableDns
- APIEnableDnsA
- APIEnableDnsAAAA
- APIEnableDnsCNAME
- APIEnableDnsZones

----

## APIEnableAD
## Enable ALL AD Sections

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.
When you enable/disable this section, you will see/hide the **AD Computer**, **AD Users**, **AD Organization Units (OU)**, **AD Groups**, and **AD Group Membership** sections.

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

Expand All @@ -55,7 +55,7 @@ Restart the web server using the **IISReset command** or the IIS Console.

----

## APIEnableADComputer
## Enable the AD Computer Section

The **APIEnableADComputer** setting manages the **AD Computer** section.

Expand All @@ -81,11 +81,115 @@ Restart the web server using the **IISReset command** or the IIS Console.

----

## APIEnableDNS
## Enable the AD Group Section

The **APIEnableADGroup** setting manages the **AD Groups** section.

When you enable/disable this section, you will see/hide the **AD Group** section.

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

> AD Group Section Enabled
```
"APIEnableADGroup: true"
```

> AD Group Section Disabled
```
"APIEnableADGroup: false"
```

Save the file.

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

----

## Enable the AD Group Membership Section

The **APIEnableADGroupMembership** setting manages the **AD Group Membership** section.

When you enable/disable this section, you will see/hide the **AD Group Membership** section.

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

> AD Group Membership Section Enabled
```
"APIEnableADGroupMembership: true"
```

> AD Group Membership Section Disabled
```
"APIEnableADGroupMembership: false"
```

Save the file.

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

----

## Enable the AD User Section

The **APIEnableADUser** setting manages the **AD Users** section.

When you enable/disable this section, you will see/hide the **AD Users** section.

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

> AD User Section Enabled
```
"APIEnableADUser: true"
```

> AD User Section Disabled
```
"APIEnableADUser: false"
```

Save the file.

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

----

## Enable the AD OU Section

The **APIEnableOu** setting manages the **AD Organization Units (OU)** section.

When you enable/disable this section, you will see/hide the **AD Organization Units (OU)** section.

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

> AD OU Section Enabled
```
"APIEnableADOu: true"
```

> AD OU Section Disabled
```
"APIEnableADOu: false"
```

Save the file.

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

----

## Enable ALL DNS Sections

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

When you enable/disable this section, you will see/hide the **APIEnableDnsA**, **APIEnableDnsAAAA**, **APIEnableDnsCNAME**, and **APIEnableDnsZones** sections.
When you enable/disable this section, you will see/hide the **DNS A Records**, **DNS AAAA Records**, **DNS CNAME Records**, **DNS Zones**, **DNS Lookup Zones**, and **DNS Reverse Lookup Zones** sections.

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

Expand All @@ -104,3 +208,91 @@ Open the **appsettings.json** file located at the root of the KopiCloud AD API f
Save the file.

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

----

## Enable DNS A Records Section

The **APIEnableDnsA** setting manages the **DNS A Records** section.

When you enable/disable this section, you will see/hide the **DNS A Records** sections.

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

> DNS A Records Section Enabled
```
"APIEnableDnsA: true"
```

> DNS A Records Section Disabled
```
"APIEnableDnsA: false"
```

----

## Enable DNS AAAA Records Section

The **APIEnableDnsAAAA** setting manages the **DNS AAAA Records** section.

When you enable/disable this section, you will see/hide the **DNS AAAA Records** sections.

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

> DNS AAAA Records Section Enabled
```
"APIEnableDnsAAAA: true"
```

> DNS AAAA Records Section Disabled
```
"APIEnableDnsAAAA: false"
```

----

## Enable DNS CNAME Records Section

The **APIEnableDnsCNAME** setting manages the **DNS CNAME Records** section.

When you enable/disable this section, you will see/hide the **DNS CNAME Records** sections.

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

> DNS CNAME Records Section Enabled
```
"APIEnableDnsCNAME: true"
```

> DNS CNAME Records Section Disabled
```
"APIEnableDnsCNAME: false"
```

----

## Enable DNS Zones Section

The **APIEnableDnsZones** setting manages the **DNS Zones**, **DNS Lookup Zones**, and **DNS Reverse Lookup Zones** sections.

When you enable/disable this section, you will see/hide the **DNS Zones**, **DNS Lookup Zones**, and **DNS Reverse Lookup Zones** sections.

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

> DNS Zones Sections Enabled
```
"APIEnableDnsZones: true"
```

> DNS Zones Sections Disabled
```
"APIEnableDnsZones: false"
```

0 comments on commit d2cd3da

Please sign in to comment.