20 Directories
20.1 Get Directories
GET https://<HOST>:<PORT>/api/directories/get?version=0
Returns a list of directories or detailed information about a static user directory
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
id
The identifier or display name of the directory.
Response Body Structure
The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 30.38.1. For the JSON schema refer to section 30.38.2.
Example
20.2 Remove Directory
DELETE https://<HOST>:<PORT>/api/directories/remove?version=0
Deletes a directory from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
force
Deletes the object from the configuration even it is referenced elsewhere.
Request Body Structure
The request body must contain the identifier of the directory that should be deleted.
Example
20.3 Add Static User Directory
PUT https://<HOST>:<PORT>/api/directories/staticUserDirectories/add?version=0
Creates a new static user directory.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request Body Structure
The request body is structured as StaticUserDirectory JSON object. A description for its fields is at section 30.39.1. For the JSON schema refer to section 30.39.2.
Response Body Structure
The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 30.38.1. For the JSON schema refer to section 30.38.2.
Example
20.4 Set Static User Directory
PUT https://<HOST>:<PORT>/api/directories/staticUserDirectories/set?version=0
Modifies an existing static user directory.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request Body Structure
The request body is structured as StaticUserDirectory JSON object. A description for its fields is at section 30.39.1. For the JSON schema refer to section 30.39.2.
Response Body Structure
The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 30.38.1. For the JSON schema refer to section 30.38.2.
Example
20.5 Set OAuth Client Secret
PUT https://<HOST>:<PORT>/api/directories/azureActiveDirectories/clientSecret/set?version=0
Modifies the OAuth client secret for a selected Azure Active Directory.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
directoryId
The id or display name of the Azure Active Directory which client secret will be modified.
Request Body Structure
The body must contain the new client secrect for the OAuth Client of the directory.