Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 2.15 KB

DirectoriesApi.md

File metadata and controls

88 lines (53 loc) · 2.15 KB

DirectoriesApi

All URIs are relative to https://<CROWD_URL>/rest/bootstrapi/1

Method HTTP request Description
deleteDirectories DELETE /directories Delete all user directories
getDirectories GET /directories Get all user directories
setDirectories PUT /directories Set a list of user directories

deleteDirectories

deleteDirectories(force)

Delete all user directories

NOTE: The &#39;force&#39; parameter must be set to &#39;true&#39; in order to execute this request.

Parameters

Name Type Description Notes
force Boolean [optional] [default to null]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

getDirectories

List getDirectories()

Get all user directories

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setDirectories

List setDirectories(AbstractDirectoryBean, test-connection)

Set a list of user directories

NOTE: All existing directories with the same &#39;name&#39; attribute are updated.

Parameters

Name Type Description Notes
AbstractDirectoryBean List
test-connection Boolean [optional] [default to false]

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json