dracoon.public
Module dracoon.public
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_dracoon.public_1.4.0.png)
ballerinax/dracoon.public Ballerina library
Overview
This is a generated connector for Dracoon API v4.28.3 OpenAPI specification.
Dracoon allows to store bussiness files using client sode encryption, file sharing and data access over cloud.
Ballerina connector for Dracoon allows integration with Dracoon REST API via Ballerina language.
Prerequisites
- Create an Dracoon account
- Obtaining tokens
- Use this guide to obtain the API key related to your account
Clients![](/images/permalink.svg)
dracoon.public: Client![](/images/permalink.svg)
This is a generated connector from Dracoon API v4.28.3 OpenAPI specification.
REST Web Services for DRACOON. Developer Information Get SDKs on GitHub
Terms of service
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Dracoon account and obtain OAuth tokens following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://stats.bis.org/api/v1" - URL of the target service
login![](/images/permalink.svg)
function login(LoginRequest payload) returns LoginResponse|error
Authenticate user (Login)
Parameters
- payload LoginRequest - User credentials
Return Type
- LoginResponse|error - OK
Deprecated
initiateOpenIdLogin![](/images/permalink.svg)
function initiateOpenIdLogin(string issuer, string redirectUri, string language, boolean test) returns Response|error
Initiate OpenID Connect authentication
Parameters
- issuer string - Issuer identifier of the OpenID Connect identity provider
- redirectUri string - Redirect URI to complete the OpenID Connect authentication
- language string - Language ID or ISO 639-1 code
- test boolean - Flag to test the authentication parameters. If the request is valid, the API will respond with
204 No Content
.Deprecated parameters
completeOpenIdLogin![](/images/permalink.svg)
function completeOpenIdLogin(string code, string state, string? idToken) returns LoginResponse|error
Complete OpenID Connect authentication
Parameters
- code string - Authorization code
- state string - Authentication state
- idToken string? (default ()) - Identity token
Return Type
- LoginResponse|error - OK
Deprecated
requestOpenIdAuthResources![](/images/permalink.svg)
function requestOpenIdAuthResources() returns OpenIdAuthResources|error
Request OpenID Connect authentication resources
Return Type
- OpenIdAuthResources|error - OK
Deprecated
ping![](/images/permalink.svg)
Ping
recoverUserName![](/images/permalink.svg)
function recoverUserName(RecoverUserNameRequest payload) returns Response|error
Recover username
Parameters
- payload RecoverUserNameRequest -
requestPasswordReset![](/images/permalink.svg)
function requestPasswordReset(ResetPasswordRequest payload) returns Response|error
Request password reset
Parameters
- payload ResetPasswordRequest -
validateResetPasswordToken![](/images/permalink.svg)
function validateResetPasswordToken(string token) returns ResetPasswordTokenValidateResponse|error
Validate information for password reset
Parameters
- token string - Password reset token
Return Type
resetPassword![](/images/permalink.svg)
function resetPassword(string token, ResetPasswordWithTokenRequest payload) returns Response|error
Reset password
requestSystemDefaultsInfo![](/images/permalink.svg)
function requestSystemDefaultsInfo(string? xSdsAuthToken) returns SystemDefaults|error
Request default values
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SystemDefaults|error - OK
requestGeneralSettingsInfo![](/images/permalink.svg)
function requestGeneralSettingsInfo(string? xSdsAuthToken) returns GeneralSettingsInfo|error
Request general settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- GeneralSettingsInfo|error - OK
requestInfrastructurePropertiesInfo![](/images/permalink.svg)
function requestInfrastructurePropertiesInfo(string? xSdsAuthToken) returns InfrastructureProperties|error
Request infrastructure properties
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestNotificationChannelsInfo![](/images/permalink.svg)
function requestNotificationChannelsInfo(string? xSdsAuthToken) returns NotificationChannelList|error
Request list of notification channels
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestAlgorithms![](/images/permalink.svg)
function requestAlgorithms(string? xSdsAuthToken) returns AlgorithmVersionInfoList|error
Request algorithms
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestPasswordPoliciesConfigInfo![](/images/permalink.svg)
function requestPasswordPoliciesConfigInfo(string? xSdsAuthToken) returns PasswordPoliciesConfig|error
Request password policies
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestS3TagsInfo![](/images/permalink.svg)
Request list of configured S3 tags
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestSystemSettings![](/images/permalink.svg)
function requestSystemSettings(string? xSdsAuthToken) returns ConfigOptionList|error
Request system settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- ConfigOptionList|error - OK
Deprecated
updateSystemSettings![](/images/permalink.svg)
function updateSystemSettings(ConfigOptionList payload, string? xSdsAuthToken) returns Response|error
Update system settings
downloadAvatar![](/images/permalink.svg)
Download avatar
downloadZipArchiveViaToken![](/images/permalink.svg)
Download ZIP archive
Parameters
- token string - Download token
downloadFileViaToken![](/images/permalink.svg)
function downloadFileViaToken(string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file
Parameters
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
downloadfileviatoken1![](/images/permalink.svg)
function downloadfileviatoken1(string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file
Parameters
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
requestAuditNodeUserData![](/images/permalink.svg)
function requestAuditNodeUserData(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns AuditNodeResponse[]|error
Request node assigned users with permissions
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- AuditNodeResponse[]|error - OK
requestLogEventsAsJson![](/images/permalink.svg)
function requestLogEventsAsJson(string? xSdsDateFormat, string? sort, int? offset, int? 'limit, string? dateStart, string? dateEnd, int? 'type, int? userId, string? status, string? userClient, string? xSdsAuthToken) returns LogEventList|error
Request system events
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- dateStart string? (default ()) - Filter events from given date e.g.
2015-12-31T23:59:00
- dateEnd string? (default ()) - Filter events until given date e.g.
2015-12-31T23:59:00
- 'type int? (default ()) - Operation ID cf.
GET /eventlog/operations
- userId int? (default ()) - User ID
- status string? (default ()) - Operation status: *
0
- Success *2
- Error
- userClient string? (default ()) - User client
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- LogEventList|error - OK
requestLogOperations![](/images/permalink.svg)
function requestLogOperations(boolean? isDeprecated, string? xSdsAuthToken) returns LogOperationList|error
Request allowed Log Operations
Parameters
- isDeprecated boolean? (default ()) - Show only deprecated operations
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- LogOperationList|error - OK
requestGroups![](/images/permalink.svg)
function requestGroups(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns GroupList|error
Request list of user groups
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
createGroup![](/images/permalink.svg)
function createGroup(CreateGroupRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Group|error
Create new user group
Parameters
- payload CreateGroupRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestGroup![](/images/permalink.svg)
function requestGroup(int groupId, string? xSdsDateFormat, string? xSdsAuthToken) returns Group|error
Request user group
Parameters
- groupId int - Group ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
updateGroup![](/images/permalink.svg)
function updateGroup(int groupId, UpdateGroupRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Group|error
Update user group's metadata
Parameters
- groupId int - Group ID
- payload UpdateGroupRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeGroup![](/images/permalink.svg)
Remove user group
requestLastAdminRoomsGroups![](/images/permalink.svg)
function requestLastAdminRoomsGroups(int groupId, string? xSdsAuthToken) returns LastAdminGroupRoomList|error
Request rooms where the group is defined as last admin group
Return Type
requestGroupRoles![](/images/permalink.svg)
Request list of roles assigned to the group
requestGroupRooms![](/images/permalink.svg)
function requestGroupRooms(int groupId, string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns RoomTreeDataList|error
Request rooms granted to the group or / and rooms that can be granted
Parameters
- groupId int - Group ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomTreeDataList|error - OK
Deprecated
requestGroupMembers![](/images/permalink.svg)
function requestGroupMembers(int groupId, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns GroupUserList|error
Request group member users or / and users who can become a member
Parameters
- groupId int - Group ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- GroupUserList|error - OK
addGroupMembers![](/images/permalink.svg)
function addGroupMembers(int groupId, ChangeGroupMembersRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Group|error
Add group members
Parameters
- groupId int - Group ID
- payload ChangeGroupMembersRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeGroupMembers![](/images/permalink.svg)
function removeGroupMembers(int groupId, string? xSdsDateFormat, string? xSdsAuthToken) returns Group|error
Remove group members
Parameters
- groupId int - Group ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestNodes![](/images/permalink.svg)
function requestNodes(string? xSdsDateFormat, int? depthLevel, int? parentId, boolean? roomManager, string? filter, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns NodeList|error
Request list of nodes
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- depthLevel int? (default ()) -
0
- top level nodes only *n
(any positive number) - includen
levels starting from the current node
- parentId int? (default ()) - Parent node ID. Only rooms and folders can be parents. Parent ID
0
or empty is the root node.
- roomManager boolean? (default ()) - Show all rooms for management perspective. Only possible for Rooms Managers. For all other users, it will be ignored.
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
Deprecated parameters
removeNodes![](/images/permalink.svg)
Remove nodes
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
updateNodeComment![](/images/permalink.svg)
function updateNodeComment(int commentId, ChangeNodeCommentRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Comment|error
Edit node comment
Parameters
- commentId int - Comment ID
- payload ChangeNodeCommentRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeNodeComment![](/images/permalink.svg)
Remove node comment
removeDeletedNodes![](/images/permalink.svg)
Remove nodes from recycle bin
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
restoreNodes![](/images/permalink.svg)
function restoreNodes(RestoreDeletedNodesRequest payload, string? xSdsAuthToken) returns Response|error
Restore deleted nodes
Parameters
- payload RestoreDeletedNodesRequest -
- xSdsAuthToken string? (default ()) - Authentication token
requestDeletedNode![](/images/permalink.svg)
function requestDeletedNode(int deletedNodeId, string? xSdsDateFormat, string? xSdsAuthToken) returns DeletedNode|error
Request deleted node
Parameters
- deletedNodeId int - Deleted node ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DeletedNode|error - OK
updateFavorites![](/images/permalink.svg)
function updateFavorites(UpdateFavoritesBulkRequest payload, string? xSdsAuthToken) returns Response|error
Mark or unmark a list of nodes (room, folder or file) as favorite
Parameters
- payload UpdateFavoritesBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
updateFiles![](/images/permalink.svg)
function updateFiles(UpdateFilesBulkRequest payload, string? xSdsAuthToken) returns Response|error
Updates a list of file’s metadata
Parameters
- payload UpdateFilesBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
setUserFileKeys![](/images/permalink.svg)
function setUserFileKeys(UserFileKeySetBatchRequest payload, string? xSdsAuthToken) returns Response|error
Set file keys for a list of users and files
Parameters
- payload UserFileKeySetBatchRequest -
- xSdsAuthToken string? (default ()) - Authentication token
createFileUploadChannel![](/images/permalink.svg)
function createFileUploadChannel(CreateFileUploadRequest payload, string? xSdsAuthToken) returns CreateFileUploadResponse|error
Create new file upload channel
Parameters
- payload CreateFileUploadRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- CreateFileUploadResponse|error - Created
requestUploadStatusFiles![](/images/permalink.svg)
function requestUploadStatusFiles(string uploadId, string? xSdsDateFormat, string? xSdsAuthToken) returns S3FileUploadStatus|error
Request status of S3 file upload
Parameters
- uploadId string - Upload channel ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- S3FileUploadStatus|error - OK
completeFileUpload![](/images/permalink.svg)
function completeFileUpload(string uploadId, CompleteUploadRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Complete file upload
Parameters
- uploadId string - Upload channel ID
- payload CompleteUploadRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
uploadFileAsMultipart![](/images/permalink.svg)
function uploadFileAsMultipart(string uploadId, UploadsUploadIdBody payload, string? contentRange, string? xSdsAuthToken) returns ChunkUploadResponse|error
Upload file
Parameters
- uploadId string - Upload channel ID
- payload UploadsUploadIdBody - File
- contentRange string? (default ()) - Content-Range e.g.
bytes 0-999/3980
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- ChunkUploadResponse|error - Created
Deprecated
cancelFileUpload![](/images/permalink.svg)
Cancel file upload
Parameters
- uploadId string - Upload channel ID
- xSdsAuthToken string? (default ()) - Authentication token
completeS3FileUpload![](/images/permalink.svg)
function completeS3FileUpload(string uploadId, CompleteS3FileUploadRequest payload, string? xSdsAuthToken) returns Response|error
Complete S3 file upload
Parameters
- uploadId string - Upload channel ID
- payload CompleteS3FileUploadRequest -
- xSdsAuthToken string? (default ()) - Authentication token
generatePresignedUrlsFiles![](/images/permalink.svg)
function generatePresignedUrlsFiles(string uploadId, GeneratePresignedUrlsRequest payload, string? xSdsAuthToken) returns PresignedUrlList|error
Generate presigned URLs for S3 file upload
Parameters
- uploadId string - Upload channel ID
- payload GeneratePresignedUrlsRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- PresignedUrlList|error - Created
updateFile![](/images/permalink.svg)
function updateFile(int fileId, UpdateFileRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Updates a file’s metadata
Parameters
- fileId int - File ID
- payload UpdateFileRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomRescueKey![](/images/permalink.svg)
function requestRoomRescueKey(int fileId, string? 'version, string? xSdsAuthToken) returns FileKey|error
Request room rescue key
Parameters
- fileId int - File ID
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
requestSystemRescueKey![](/images/permalink.svg)
function requestSystemRescueKey(int fileId, string? 'version, string? xSdsAuthToken) returns FileKey|error
Request system rescue key
Parameters
- fileId int - File ID
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
downloadFile![](/images/permalink.svg)
function downloadFile(int fileId, string? range, boolean? genericMimetype, boolean? inline, string? xSdsAuthToken) returns Response|error
Download file
Parameters
- fileId int - File ID
- range string? (default ()) - Range e.g.
bytes=0-999/3980
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
- xSdsAuthToken string? (default ()) - Authentication token
generateDownloadUrl![](/images/permalink.svg)
function generateDownloadUrl(int fileId, string? xSdsAuthToken) returns DownloadTokenGenerateResponse|error
Generate download URL
Return Type
downloadfile1![](/images/permalink.svg)
function downloadfile1(int fileId, string? range, boolean? genericMimetype, boolean? inline, string? xSdsAuthToken) returns Response|error
Download file
Parameters
- fileId int - File ID
- range string? (default ()) - Range e.g.
bytes=0-999/3980
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
- xSdsAuthToken string? (default ()) - Authentication token
requestUserFileKey![](/images/permalink.svg)
function requestUserFileKey(int fileId, string? 'version, string? xSdsAuthToken) returns FileKey|error
Request user's file key
Parameters
- fileId int - File ID
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
createFolder![](/images/permalink.svg)
function createFolder(CreateFolderRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Create new folder
Parameters
- payload CreateFolderRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
updateFolder![](/images/permalink.svg)
function updateFolder(int folderId, UpdateFolderRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Updates folder’s metadata
Parameters
- folderId int - Folder ID
- payload UpdateFolderRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestMissingFileKeys![](/images/permalink.svg)
function requestMissingFileKeys(int? offset, int? 'limit, int? roomId, int? fileId, int? userId, string? useKey, string? xSdsAuthToken) returns MissingKeysResponse|error
Request files without user's file key
Parameters
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- roomId int? (default ()) - Room ID
- fileId int? (default ()) - File ID
- userId int? (default ()) - User ID
- useKey string? (default ()) - Determines which key should be used (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- MissingKeysResponse|error - OK
createRoom![](/images/permalink.svg)
function createRoom(CreateRoomRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Create new room
Parameters
- payload CreateRoomRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestPendingAssignments![](/images/permalink.svg)
function requestPendingAssignments(int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns PendingAssignmentList|error
Request user-room assignments per group
Parameters
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
changePendingAssignments![](/images/permalink.svg)
function changePendingAssignments(PendingAssignmentsRequest payload, string? xSdsAuthToken) returns Response|error
Handle user-room assignments per group
Parameters
- payload PendingAssignmentsRequest -
- xSdsAuthToken string? (default ()) - Authentication token
updateRoom![](/images/permalink.svg)
function updateRoom(int roomId, UpdateRoomRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Updates room’s metadata
Parameters
- roomId int - Room ID
- payload UpdateRoomRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomActivitiesLogAsJsonOld![](/images/permalink.svg)
function requestRoomActivitiesLogAsJsonOld(int roomId, string? xSdsDateFormat, string? sort, int? offset, int? 'limit, string? dateStart, string? dateEnd, int? 'type, int? userId, int? status, string? xSdsAuthToken) returns SyslogEventList|error
Request events of a room
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- dateStart string? (default ()) - Filter events from given date e.g.
2015-12-31T23:59:00
- dateEnd string? (default ()) - Filter events until given date e.g.
2015-12-31T23:59:00
- 'type int? (default ()) - Operation ID cf.
GET /eventlog/operations
- userId int? (default ()) - User ID
- status int? (default ()) - Operation status: *
0
- Success *2
- Error
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SyslogEventList|error - OK
Deprecated
configureRoom![](/images/permalink.svg)
function configureRoom(int roomId, ConfigRoomRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Configure room
Parameters
- roomId int - Room ID
- payload ConfigRoomRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
encryptRoom![](/images/permalink.svg)
function encryptRoom(int roomId, EncryptRoomRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Node|error
Encrypt room
Parameters
- roomId int - Room ID
- payload EncryptRoomRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomActivitiesLogAsJson![](/images/permalink.svg)
function requestRoomActivitiesLogAsJson(int roomId, string? xSdsDateFormat, string? sort, int? offset, int? 'limit, string? dateStart, string? dateEnd, int? 'type, int? userId, int? status, string? xSdsAuthToken) returns LogEventList|error
Request events of a room
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- dateStart string? (default ()) - Filter events from given date e.g.
2015-12-31T23:59:00
- dateEnd string? (default ()) - Filter events until given date e.g.
2015-12-31T23:59:00
- 'type int? (default ()) - Operation ID cf.
GET /eventlog/operations
- userId int? (default ()) - User ID
- status int? (default ()) - Operation status: *
0
- Success *2
- Error
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- LogEventList|error - OK
requestRoomGroups![](/images/permalink.svg)
function requestRoomGroups(int roomId, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns RoomGroupList|error
Request room granted group(s) or / and group(s) that can be granted
Parameters
- roomId int - Room ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomGroupList|error - OK
updateRoomGroups![](/images/permalink.svg)
function updateRoomGroups(int roomId, RoomGroupsAddBatchRequest payload, string? xSdsAuthToken) returns Response|error
Add or change room granted group(s)
Parameters
- roomId int - Room ID
- payload RoomGroupsAddBatchRequest -
- xSdsAuthToken string? (default ()) - Authentication token
revokeRoomGroups![](/images/permalink.svg)
function revokeRoomGroups(int roomId, string? xSdsDateFormat, string? xSdsAuthToken) returns Response|error
Revoke granted group(s) from room
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomRescueKeyPair![](/images/permalink.svg)
function requestRoomRescueKeyPair(int roomId, string? xSdsDateFormat, string? 'version, string? xSdsAuthToken) returns UserKeyPairContainer|error
Request room rescue key
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
setRoomRescueKeyPair![](/images/permalink.svg)
function setRoomRescueKeyPair(int roomId, UserKeyPairContainer payload, string? xSdsAuthToken) returns Response|error
Set room's rescue key pair
Parameters
- roomId int - Room ID
- payload UserKeyPairContainer -
- xSdsAuthToken string? (default ()) - Authentication token
removeRoomRescueKeyPair![](/images/permalink.svg)
function removeRoomRescueKeyPair(int roomId, string? 'version, string? xSdsAuthToken) returns Response|error
Remove rooms's rescue key pair
Parameters
- roomId int - Room ID
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomRescueKeyPairs![](/images/permalink.svg)
function requestRoomRescueKeyPairs(int roomId, string? xSdsDateFormat, string? xSdsAuthToken) returns UserKeyPairContainer[]|error
Request all room rescue key pairs
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserKeyPairContainer[]|error - No Content
createAndPreserveRoomRescueKeyPair![](/images/permalink.svg)
function createAndPreserveRoomRescueKeyPair(int roomId, CreateKeyPairRequest payload, string? xSdsAuthToken) returns Response|error
Create key pair and preserve copy of old private key
Parameters
- roomId int - Room ID
- payload CreateKeyPairRequest -
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomS3Tags![](/images/permalink.svg)
Request list of all assigned S3 tags to the room
setRoomS3Tags![](/images/permalink.svg)
Set S3 tags for a room
Parameters
- roomId int - Room ID
- payload S3TagIds -
- xSdsAuthToken string? (default ()) - Authentication token
requestRoomUsers![](/images/permalink.svg)
function requestRoomUsers(int roomId, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns RoomUserList|error
Request room granted user(s) or / and user(s) that can be granted
Parameters
- roomId int - Room ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomUserList|error - OK
updateRoomUsers![](/images/permalink.svg)
function updateRoomUsers(int roomId, RoomUsersAddBatchRequest payload, string? xSdsAuthToken) returns Response|error
Add or change room granted user(s)
Parameters
- roomId int - Room ID
- payload RoomUsersAddBatchRequest -
- xSdsAuthToken string? (default ()) - Authentication token
revokeRoomUsers![](/images/permalink.svg)
Revoke granted user(s) from room
requestListOfWebhooksForRoom![](/images/permalink.svg)
function requestListOfWebhooksForRoom(int roomId, string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns RoomWebhookList|error
Request list of webhooks that are assigned or can be assigned to this room
Parameters
- roomId int - Room ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomWebhookList|error - OK
handleRoomWebhookAssignments![](/images/permalink.svg)
function handleRoomWebhookAssignments(int roomId, UpdateRoomWebhookRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns RoomWebhookList|error
Assign or unassign webhooks to room
Parameters
- roomId int - Room ID
- payload UpdateRoomWebhookRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomWebhookList|error - OK
searchNodes![](/images/permalink.svg)
function searchNodes(string searchString, string? xSdsDateFormat, int? depthLevel, int? parentId, string? filter, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns NodeList|error
Search nodes
Parameters
- searchString string - Search string
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- depthLevel int? (default ()) -
0
- top level nodes only (default) *-1
- full tree *n
(any positive number) - includen
levels starting from the current node
- parentId int? (default ()) - Parent node ID. Only rooms and folders can be parents. Parent ID
0
or empty is the root node.
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
generateDownloadUrlForZipArchive![](/images/permalink.svg)
function generateDownloadUrlForZipArchive(ZipDownloadRequest payload, string? xSdsAuthToken) returns DownloadTokenGenerateResponse|error
Generate download URL for ZIP download
Return Type
downloadZipArchive![](/images/permalink.svg)
function downloadZipArchive(ZipDownloadRequest payload, string? xSdsAuthToken) returns Response|error
Download files / folders as ZIP archive
requestNode![](/images/permalink.svg)
Request node
Parameters
- nodeId int - Node ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeNode![](/images/permalink.svg)
Remove node
requestNodeComments![](/images/permalink.svg)
function requestNodeComments(int nodeId, string? xSdsDateFormat, int? offset, int? 'limit, boolean? hideDeleted, string? xSdsAuthToken) returns CommentList|error
Request list of node comments
Parameters
- nodeId int - Node ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- hideDeleted boolean? (default ()) - Hide deleted comments (default: false)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- CommentList|error - OK
createNodeComment![](/images/permalink.svg)
function createNodeComment(int nodeId, CreateNodeCommentRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Comment|error
Create node comment
Parameters
- nodeId int - Node ID
- payload CreateNodeCommentRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
copyNodes![](/images/permalink.svg)
function copyNodes(int nodeId, CopyNodesRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns string|Node|error
Copy node(s)
Parameters
- nodeId int - Target parent node ID
- payload CopyNodesRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestDeletedNodesSummary![](/images/permalink.svg)
function requestDeletedNodesSummary(int nodeId, string? xSdsDateFormat, string? filter, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns DeletedNodeSummaryList|error
Request list of deleted nodes
Parameters
- nodeId int - Parent ID (can only be a room ID)
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
emptyDeletedNodes![](/images/permalink.svg)
Empty recycle bin
requestDeletedNodeVersions![](/images/permalink.svg)
function requestDeletedNodeVersions(int nodeId, string 'type, string name, string? xSdsDateFormat, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns DeletedNodeVersionsList|error
Request deleted versions of nodes
Parameters
- nodeId int - Parent ID (room or folder ID)
- 'type string - Node type
- name string - Node name
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
addFavorite![](/images/permalink.svg)
Mark a node (room, folder or file) as favorite
Parameters
- nodeId int - Node ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeFavorite![](/images/permalink.svg)
Unmark a node (room, folder or file) as favorite
moveNodes![](/images/permalink.svg)
function moveNodes(int nodeId, MoveNodesRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns string|Node|error
Move node(s)
Parameters
- nodeId int - Target parent node ID
- payload MoveNodesRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestNodeParents![](/images/permalink.svg)
function requestNodeParents(int nodeId, string? xSdsAuthToken) returns NodeParentList|error
Request list of parent nodes
Return Type
- NodeParentList|error - OK
requestCustomers![](/images/permalink.svg)
function requestCustomers(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, boolean? includeAttributes, string? xSdsServiceToken) returns CustomerList|error
Request list of customers
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- includeAttributes boolean? (default ()) - Include custom customer attributes.
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
- CustomerList|error - OK
createCustomer![](/images/permalink.svg)
function createCustomer(NewCustomerRequest payload, string? xSdsDateFormat, string? xSdsServiceToken) returns NewCustomerResponse|error
Create customer
Parameters
- payload NewCustomerRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
- NewCustomerResponse|error - Created
requestCustomer![](/images/permalink.svg)
function requestCustomer(int customerId, string? xSdsDateFormat, boolean? includeAttributes, string? xSdsServiceToken) returns Customer|error
Get customer
Parameters
- customerId int - Customer ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- includeAttributes boolean? (default ()) - Include custom customer attributes.
- xSdsServiceToken string? (default ()) - Service Authentication token
updateCustomer![](/images/permalink.svg)
function updateCustomer(int customerId, UpdateCustomerRequest payload, string? xSdsDateFormat, string? xSdsServiceToken) returns UpdateCustomerResponse|error
Update customer
Parameters
- customerId int - Customer ID
- payload UpdateCustomerRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
removeCustomer![](/images/permalink.svg)
Remove customer
Parameters
- customerId int - Customer ID
- xSdsServiceToken string? (default ()) - Service Authentication token
requestCustomerAttributes![](/images/permalink.svg)
function requestCustomerAttributes(int customerId, int? offset, int? 'limit, string? filter, string? sort, string? xSdsServiceToken) returns AttributesResponse|error
Request customer attributes
Parameters
- customerId int - Customer ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
- AttributesResponse|error - OK
updateCustomerAttributes![](/images/permalink.svg)
function updateCustomerAttributes(int customerId, CustomerAttributes payload, string? xSdsDateFormat, string? xSdsServiceToken) returns Customer|error
Add or edit customer attributes
Parameters
- customerId int - Customer ID
- payload CustomerAttributes -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
setCustomerAttributes![](/images/permalink.svg)
function setCustomerAttributes(int customerId, CustomerAttributes payload, string? xSdsDateFormat, string? xSdsServiceToken) returns Customer|error
Set customer attributes
Parameters
- customerId int - Customer ID
- payload CustomerAttributes -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
removeCustomerAttribute![](/images/permalink.svg)
function removeCustomerAttribute(int customerId, string 'key, string? xSdsServiceToken) returns Response|error
Remove customer attribute
Parameters
- customerId int - Customer ID
- 'key string - Key
- xSdsServiceToken string? (default ()) - Service Authentication token
requestCustomerUsers![](/images/permalink.svg)
function requestCustomerUsers(int customerId, string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, boolean? includeAttributes, boolean? includeRoles, boolean? includeManageableRooms, string? xSdsServiceToken) returns UserList|error
Request list of customer users
Parameters
- customerId int - Customer ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- includeAttributes boolean? (default ()) - Include custom user attributes.
- includeRoles boolean? (default ()) - Include roles
- includeManageableRooms boolean? (default ()) - Include hasManageableRooms (deprecated)
- xSdsServiceToken string? (default ()) - Service Authentication token
requestListOfTenantWebhooks![](/images/permalink.svg)
function requestListOfTenantWebhooks(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, string? xSdsServiceToken) returns WebhookList|error
Request list of tenant webhooks
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
- WebhookList|error - OK
createTenantWebhook![](/images/permalink.svg)
function createTenantWebhook(CreateWebhookRequest payload, string? xSdsDateFormat, string? xSdsServiceToken) returns Webhook|error
Create tenant webhook
Parameters
- payload CreateWebhookRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
requestListOfEventTypesForTenant![](/images/permalink.svg)
function requestListOfEventTypesForTenant(string? xSdsServiceToken) returns EventTypeList|error
Request list of event types
Parameters
- xSdsServiceToken string? (default ()) - Service Authentication token
Return Type
- EventTypeList|error - OK
requestTenantWebhook![](/images/permalink.svg)
function requestTenantWebhook(int webhookId, string? xSdsDateFormat, string? xSdsServiceToken) returns Webhook|error
Request tenant webhook
Parameters
- webhookId int - Webhook ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
updateTenantWebhook![](/images/permalink.svg)
function updateTenantWebhook(int webhookId, UpdateWebhookRequest payload, string? xSdsDateFormat, string? xSdsServiceToken) returns Webhook|error
Update tenant webhook
Parameters
- webhookId int - Webhook ID
- payload UpdateWebhookRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
removeTenantWebhook![](/images/permalink.svg)
Remove tenant webhook
Parameters
- webhookId int - Webhook ID
- xSdsServiceToken string? (default ()) - Service Authentication token
resetTenantWebhookLifetime![](/images/permalink.svg)
function resetTenantWebhookLifetime(int webhookId, string? xSdsDateFormat, string? xSdsServiceToken) returns Webhook|error
Reset tenant webhook lifetime
Parameters
- webhookId int - Webhook ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsServiceToken string? (default ()) - Service Authentication token
requestPublicDownloadShareInfo![](/images/permalink.svg)
function requestPublicDownloadShareInfo(string accessKey, string? xSdsDateFormat) returns PublicDownloadShare|error
Request public Download Share information
Parameters
- accessKey string - Access key
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicDownloadShare|error - OK
generateDownloadUrlPublic![](/images/permalink.svg)
function generateDownloadUrlPublic(string accessKey, PublicDownloadTokenGenerateRequest payload) returns PublicDownloadTokenGenerateResponse|error
Generate download URL
Return Type
- PublicDownloadTokenGenerateResponse|error - Created
downloadFileViaTokenPublic![](/images/permalink.svg)
function downloadFileViaTokenPublic(string accessKey, string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file with token
Parameters
- accessKey string - Access key
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
downloadfileviatokenpublic1![](/images/permalink.svg)
function downloadfileviatokenpublic1(string accessKey, string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file with token
Parameters
- accessKey string - Access key
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
requestPublicUploadShareInfo![](/images/permalink.svg)
function requestPublicUploadShareInfo(string accessKey, string? xSdsSharePassword, string? xSdsDateFormat) returns PublicUploadShare|error
Request public Upload Share information
Parameters
- accessKey string - Access key
- xSdsSharePassword string? (default ()) - Upload share password. Should be base64-encoded. Plain X-Sds-Share-Passwords are deprecated and will be removed in the future
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicUploadShare|error - OK
createShareUploadChannel![](/images/permalink.svg)
function createShareUploadChannel(string accessKey, CreateShareUploadChannelRequest payload) returns CreateShareUploadChannelResponse|error
Create new file upload channel
Return Type
- CreateShareUploadChannelResponse|error - Created
requestUploadStatusPublic![](/images/permalink.svg)
function requestUploadStatusPublic(string accessKey, string uploadId) returns S3ShareUploadStatus|error
Request status of S3 file upload
Return Type
- S3ShareUploadStatus|error - OK
completeFileUploadViaShare![](/images/permalink.svg)
function completeFileUploadViaShare(string accessKey, string uploadId, UserFileKeyList payload, string? xSdsDateFormat) returns PublicUploadedFileData|error
Complete file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload UserFileKeyList - Mandatory for encrypted shares
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicUploadedFileData|error - Created
uploadfileasbinarypublic1![](/images/permalink.svg)
function uploadfileasbinarypublic1(string accessKey, string uploadId, AccessKeyUploadIdBody payload, string? xSdsDateFormat, string? contentRange) returns ChunkUploadResponse|error
Upload file
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload AccessKeyUploadIdBody - File
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- contentRange string? (default ()) - Content-Range e.g.
bytes 0-999/3980
Return Type
- ChunkUploadResponse|error - Created
cancelFileUploadViaShare![](/images/permalink.svg)
Cancel file upload
completeS3FileUploadViaShare![](/images/permalink.svg)
function completeS3FileUploadViaShare(string accessKey, string uploadId, CompleteS3ShareUploadRequest payload) returns Response|error
Complete S3 file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload CompleteS3ShareUploadRequest -
generatePresignedUrlsPublic![](/images/permalink.svg)
function generatePresignedUrlsPublic(string accessKey, string uploadId, GeneratePresignedUrlsRequest payload, string? xSdsDateFormat) returns PresignedUrlList|error
Generate presigned URLs for S3 file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload GeneratePresignedUrlsRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PresignedUrlList|error - Created
requestThirdPartyDependencies![](/images/permalink.svg)
function requestThirdPartyDependencies() returns ThirdPartyDependenciesData[]|error
Request third-party software dependencies
Return Type
- ThirdPartyDependenciesData[]|error - OK
requestSoftwareVersion![](/images/permalink.svg)
function requestSoftwareVersion(string? xSdsDateFormat) returns SoftwareVersionData|error
Request software version information
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- SoftwareVersionData|error - OK
requestSystemInfo![](/images/permalink.svg)
function requestSystemInfo(boolean? isEnabled) returns SystemInfo|error
Request system information
Parameters
- isEnabled boolean? (default ()) - Show only enabled authentication methods
Return Type
- SystemInfo|error - OK
requestActiveDirectoryAuthInfo![](/images/permalink.svg)
function requestActiveDirectoryAuthInfo(boolean? isGlobalAvailable) returns ActiveDirectoryAuthInfo|error
Request Active Directory authentication information
Parameters
- isGlobalAvailable boolean? (default ()) - Show only global available items
Return Type
requestOpenIdAuthInfo![](/images/permalink.svg)
function requestOpenIdAuthInfo(boolean? isGlobalAvailable) returns OpenIdAuthInfo|error
Request OpenID Connect provider authentication information
Parameters
- isGlobalAvailable boolean? (default ()) - Show only global available items
Return Type
- OpenIdAuthInfo|error - OK
requestSystemTime![](/images/permalink.svg)
function requestSystemTime(string? xSdsDateFormat) returns SdsServerTime|error
Request system time
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- SdsServerTime|error - OK
requestSubscriptionScopes![](/images/permalink.svg)
function requestSubscriptionScopes() returns NotificationScopeList|error
Request list of subscription scopes
Return Type
requestUserAvatar![](/images/permalink.svg)
Request user avatar
requestRoles![](/images/permalink.svg)
Request all roles with assigned rights
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestRoleGroups![](/images/permalink.svg)
function requestRoleGroups(int roleId, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns RoleGroupList|error
Request groups with specific role
Parameters
- roleId int - Role ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoleGroupList|error - OK
addRoleGroups![](/images/permalink.svg)
function addRoleGroups(int roleId, GroupIds payload, string? xSdsAuthToken) returns RoleGroupList|error
Assign group(s) to the role
Parameters
- roleId int - Role ID
- payload GroupIds - Group IDs
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoleGroupList|error - OK
revokeRoleGroups![](/images/permalink.svg)
function revokeRoleGroups(int roleId, string? xSdsAuthToken) returns RoleGroupList|error
Revoke granted role from group(s)
Return Type
- RoleGroupList|error - OK
requestRoleUsers![](/images/permalink.svg)
function requestRoleUsers(int roleId, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns RoleUserList|error
Request users with specific role
Parameters
- roleId int - Role ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoleUserList|error - OK
addRoleUsers![](/images/permalink.svg)
function addRoleUsers(int roleId, UserIds payload, string? xSdsAuthToken) returns RoleUserList|error
Assign user(s) to the role
Parameters
- roleId int - Role ID
- payload UserIds - User IDs
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoleUserList|error - OK
revokeRoleUsers![](/images/permalink.svg)
function revokeRoleUsers(int roleId, string? xSdsAuthToken) returns RoleUserList|error
Revoke granted role from user(s)
Return Type
- RoleUserList|error - OK
requestSettings![](/images/permalink.svg)
function requestSettings(string? xSdsAuthToken) returns CustomerSettingsResponse|error
Request customer settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
setSettings![](/images/permalink.svg)
function setSettings(CustomerSettingsRequest payload, string? xSdsAuthToken) returns CustomerSettingsResponse|error
Set customer settings
Parameters
- payload CustomerSettingsRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestSystemRescueKeyPair![](/images/permalink.svg)
function requestSystemRescueKeyPair(string? xSdsDateFormat, string? 'version, string? xSdsAuthToken) returns UserKeyPairContainer|error
Request system rescue key pair
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
setSystemRescueKeyPair![](/images/permalink.svg)
function setSystemRescueKeyPair(UserKeyPairContainer payload, string? xSdsAuthToken) returns Response|error
Activate client-side encryption for customer
removeSystemRescueKeyPair![](/images/permalink.svg)
Remove system rescue key pair
Parameters
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
requestAllSystemRescueKeyPairs![](/images/permalink.svg)
function requestAllSystemRescueKeyPairs(string? xSdsDateFormat, string? xSdsAuthToken) returns UserKeyPairContainer[]|error
Request all system rescue key pairs
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserKeyPairContainer[]|error - OK
createAndPreserveKeyPair![](/images/permalink.svg)
function createAndPreserveKeyPair(CreateKeyPairRequest payload, string? xSdsAuthToken) returns Response|error
Create system rescue key pair and preserve copy of old private key
requestNotificationChannels![](/images/permalink.svg)
function requestNotificationChannels(string? xSdsAuthToken) returns NotificationChannelList|error
Request list of notification channels
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
toggleNotificationChannels![](/images/permalink.svg)
function toggleNotificationChannels(NotificationChannelActivationRequest payload, string? xSdsAuthToken) returns NotificationChannelList|error
Toggle notification channels
Parameters
- payload NotificationChannelActivationRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestListOfWebhooks![](/images/permalink.svg)
function requestListOfWebhooks(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns WebhookList|error
Request list of webhooks
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- WebhookList|error - OK
createWebhook![](/images/permalink.svg)
function createWebhook(CreateWebhookRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Webhook|error
Create webhook
Parameters
- payload CreateWebhookRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestListOfEventTypesForConfigManager![](/images/permalink.svg)
function requestListOfEventTypesForConfigManager(string? xSdsAuthToken) returns EventTypeList|error
Request list of event types
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- EventTypeList|error - OK
requestWebhook![](/images/permalink.svg)
function requestWebhook(int webhookId, string? xSdsDateFormat, string? xSdsAuthToken) returns Webhook|error
Request webhook
Parameters
- webhookId int - Webhook ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
updateWebhook![](/images/permalink.svg)
function updateWebhook(int webhookId, UpdateWebhookRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Webhook|error
Update webhook
Parameters
- webhookId int - Webhook ID
- payload UpdateWebhookRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeWebhook![](/images/permalink.svg)
Remove webhook
resetWebhookLifetime![](/images/permalink.svg)
function resetWebhookLifetime(int webhookId, string? xSdsDateFormat, string? xSdsAuthToken) returns Webhook|error
Reset webhook lifetime
Parameters
- webhookId int - Webhook ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestDownloadShares![](/images/permalink.svg)
function requestDownloadShares(string? xSdsDateFormat, string? filter, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns DownloadShareList|error
Request list of Download Shares
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DownloadShareList|error - OK
updateDownloadShares![](/images/permalink.svg)
function updateDownloadShares(UpdateDownloadSharesBulkRequest payload, string? xSdsAuthToken) returns Response|error
Update a list of Download Shares
Parameters
- payload UpdateDownloadSharesBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
createDownloadShare![](/images/permalink.svg)
function createDownloadShare(CreateDownloadShareRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns DownloadShare|error
Create new Download Share
Parameters
- payload CreateDownloadShareRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DownloadShare|error - Created
deleteDownloadShares![](/images/permalink.svg)
Remove Download Shares
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestDownloadShare![](/images/permalink.svg)
function requestDownloadShare(int shareId, string? xSdsDateFormat, string? xSdsAuthToken) returns DownloadShare|error
Request Download Share
Parameters
- shareId int - Share ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DownloadShare|error - OK
updateDownloadShare![](/images/permalink.svg)
function updateDownloadShare(int shareId, UpdateDownloadShareRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns DownloadShare|error
Update Download Share
Parameters
- shareId int - Share ID
- payload UpdateDownloadShareRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DownloadShare|error - OK
removeDownloadShare![](/images/permalink.svg)
Remove Download Share
sendDownloadShareLinkViaEmail![](/images/permalink.svg)
function sendDownloadShareLinkViaEmail(int shareId, DownloadShareLinkEmail payload, string? xSdsAuthToken) returns Response|error
Send an existing Download Share link via email
Parameters
- shareId int - Share ID
- payload DownloadShareLinkEmail -
- xSdsAuthToken string? (default ()) - Authentication token
requestDownloadShareQr![](/images/permalink.svg)
function requestDownloadShareQr(int shareId, string? xSdsDateFormat, string? xSdsAuthToken) returns DownloadShare|error
Request Download Share via QR Code
Parameters
- shareId int - Share ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- DownloadShare|error - OK
requestUploadShares![](/images/permalink.svg)
function requestUploadShares(string? xSdsDateFormat, string? filter, string? sort, int? offset, int? 'limit, string? xSdsAuthToken) returns UploadShareList|error
Request list of Upload Shares
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UploadShareList|error - OK
updateUploadShares![](/images/permalink.svg)
function updateUploadShares(UpdateUploadSharesBulkRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns Response|error
Update List of Upload Shares
Parameters
- payload UpdateUploadSharesBulkRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
createUploadShare![](/images/permalink.svg)
function createUploadShare(CreateUploadShareRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UploadShare|error
Create new Upload Share
Parameters
- payload CreateUploadShareRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UploadShare|error - Created
deleteUploadShares![](/images/permalink.svg)
Remove Upload Shares
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestUploadShare![](/images/permalink.svg)
function requestUploadShare(int shareId, string? xSdsDateFormat, string? xSdsAuthToken) returns UploadShare|error
Request Upload Share
Parameters
- shareId int - Share ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UploadShare|error - OK
updateUploadShare![](/images/permalink.svg)
function updateUploadShare(int shareId, UpdateUploadShareRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UploadShare|error
Update Upload Share
Parameters
- shareId int - Share ID
- payload UpdateUploadShareRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UploadShare|error - OK
removeUploadShare![](/images/permalink.svg)
Remove Upload Share
sendUploadShareLinkViaEmail![](/images/permalink.svg)
function sendUploadShareLinkViaEmail(int shareId, UploadShareLinkEmail payload, string? xSdsAuthToken) returns Response|error
Send an existing Upload Share link via email
Parameters
- shareId int - Share ID
- payload UploadShareLinkEmail -
- xSdsAuthToken string? (default ()) - Authentication token
requestUploadShareQr![](/images/permalink.svg)
function requestUploadShareQr(int shareId, string? xSdsDateFormat, string? xSdsAuthToken) returns UploadShare|error
Request Upload Share via QR Code
Parameters
- shareId int - Share ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UploadShare|error - OK
requestAuditNodeUserDataSyslog![](/images/permalink.svg)
function requestAuditNodeUserDataSyslog(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns AuditNodeResponse[]|error
Request nodes assigned users with permissions
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- AuditNodeResponse[]|error - OK
Deprecated
requestSyslogEvents![](/images/permalink.svg)
function requestSyslogEvents(string? xSdsDateFormat, string? sort, int? offset, int? 'limit, string? dateStart, string? dateEnd, int? 'type, int? userId, string? status, string? userClient, string? xSdsAuthToken) returns SyslogEventList|error
Request system events
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- dateStart string? (default ()) - Filter events from given date e.g.
2015-12-31T23:59:00
- dateEnd string? (default ()) - Filter events until given date e.g.
2015-12-31T23:59:00
- 'type int? (default ()) - Operation ID cf.
GET /eventlog/operations
- userId int? (default ()) - User ID
- status string? (default ()) - Operation status: *
0
- Success *2
- Error
- userClient string? (default ()) - User client
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SyslogEventList|error - OK
Deprecated
requestLogOperationsSyslog![](/images/permalink.svg)
function requestLogOperationsSyslog(boolean? isDeprecated, string? xSdsAuthToken) returns LogOperationList|error
Request allowed log operations
Parameters
- isDeprecated boolean? (default ()) - Show only deprecated operations
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- LogOperationList|error - OK
Deprecated
testAdConfig![](/images/permalink.svg)
function testAdConfig(TestActiveDirectoryConfigRequest payload, string? xSdsAuthToken) returns TestActiveDirectoryConfigResponse|error
Test Active Directory configuration
Parameters
- payload TestActiveDirectoryConfigRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
testRadiusConfig![](/images/permalink.svg)
Test RADIUS server availability
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestAdConfigs![](/images/permalink.svg)
function requestAdConfigs(string? xSdsAuthToken) returns ActiveDirectoryConfigList|error
Request list of Active Directory configurations
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
createAdConfig![](/images/permalink.svg)
function createAdConfig(CreateActiveDirectoryConfigRequest payload, string? xSdsAuthToken) returns ActiveDirectoryConfig|error
Create Active Directory configuration
Parameters
- payload CreateActiveDirectoryConfigRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- ActiveDirectoryConfig|error - Created
requestAdConfig![](/images/permalink.svg)
function requestAdConfig(int adId, string? xSdsAuthToken) returns ActiveDirectoryConfig|error
Request Active Directory configuration
Return Type
updateAdConfig![](/images/permalink.svg)
function updateAdConfig(int adId, UpdateActiveDirectoryConfigRequest payload, string? xSdsAuthToken) returns ActiveDirectoryConfig|error
Update Active Directory configuration
Parameters
- adId int - Active Directory ID
- payload UpdateActiveDirectoryConfigRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
removeAdConfig![](/images/permalink.svg)
Remove Active Directory configuration
requestOpenIdIdpConfigs![](/images/permalink.svg)
function requestOpenIdIdpConfigs(string? xSdsAuthToken) returns OpenIdIdpConfig[]|error
Request list of OpenID Connect IDP configurations
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OpenIdIdpConfig[]|error - OK
createOpenIdIdpConfig![](/images/permalink.svg)
function createOpenIdIdpConfig(CreateOpenIdIdpConfigRequest payload, string? xSdsAuthToken) returns OpenIdIdpConfig|error
Create OpenID Connect IDP configuration
Parameters
- payload CreateOpenIdIdpConfigRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OpenIdIdpConfig|error - Created
requestOpenIdIdpConfig![](/images/permalink.svg)
function requestOpenIdIdpConfig(int idpId, string? xSdsAuthToken) returns OpenIdIdpConfig|error
Request OpenID Connect IDP configuration
Parameters
- idpId int - OpenID Connect IDP configuration ID
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OpenIdIdpConfig|error - OK
updateOpenIdIdpConfig![](/images/permalink.svg)
function updateOpenIdIdpConfig(int idpId, UpdateOpenIdIdpConfigRequest payload, string? xSdsAuthToken) returns OpenIdIdpConfig|error
Update OpenID Connect IDP configuration
Parameters
- idpId int - OpenID Connect IDP configuration ID
- payload UpdateOpenIdIdpConfigRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OpenIdIdpConfig|error - OK
removeOpenIdIdpConfig![](/images/permalink.svg)
Remove OpenID Connect IDP configuration
Parameters
- idpId int - OpenID Connect IDP configuration ID
- xSdsAuthToken string? (default ()) - Authentication token
requestRadiusConfig![](/images/permalink.svg)
function requestRadiusConfig(string? xSdsAuthToken) returns RadiusConfig|error
Request RADIUS configuration
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RadiusConfig|error - OK
updateRadiusConfig![](/images/permalink.svg)
function updateRadiusConfig(RadiusConfigUpdateRequest payload, string? xSdsAuthToken) returns RadiusConfig|error
Update RADIUS configuration
Parameters
- payload RadiusConfigUpdateRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RadiusConfig|error - OK
createRadiusConfig![](/images/permalink.svg)
function createRadiusConfig(RadiusConfigCreateRequest payload, string? xSdsAuthToken) returns RadiusConfig|error
Create RADIUS configuration
Parameters
- payload RadiusConfigCreateRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RadiusConfig|error - Created
removeRadiusConfig![](/images/permalink.svg)
Remove RADIUS configuration
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestOAuthClients![](/images/permalink.svg)
function requestOAuthClients(string? filter, string? sort, string? xSdsAuthToken) returns OAuthClient[]|error
Request list of OAuth clients
Parameters
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthClient[]|error - OK
createOAuthClient![](/images/permalink.svg)
function createOAuthClient(CreateOAuthClientRequest payload, string? xSdsAuthToken) returns OAuthClient|error
Create OAuth client
Parameters
- payload CreateOAuthClientRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthClient|error - Created
requestOAuthClient![](/images/permalink.svg)
function requestOAuthClient(string clientId, string? xSdsAuthToken) returns OAuthClient|error
Request OAuth client
Parameters
- clientId string - OAuth client ID
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthClient|error - OK
updateOAuthClient![](/images/permalink.svg)
function updateOAuthClient(string clientId, UpdateOAuthClientRequest payload, string? xSdsAuthToken) returns OAuthClient|error
Update OAuth client
Parameters
- clientId string - OAuth client ID
- payload UpdateOAuthClientRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthClient|error - OK
removeOAuthClient![](/images/permalink.svg)
Remove OAuth client
Parameters
- clientId string - OAuth client ID
- xSdsAuthToken string? (default ()) - Authentication token
requestPasswordPoliciesConfig![](/images/permalink.svg)
function requestPasswordPoliciesConfig(string? xSdsAuthToken) returns PasswordPoliciesConfig|error
Request password policies
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
changePasswordPoliciesConfig![](/images/permalink.svg)
function changePasswordPoliciesConfig(UpdatePasswordPoliciesConfig payload, string? xSdsAuthToken) returns PasswordPoliciesConfig|error
Change password policies
Parameters
- payload UpdatePasswordPoliciesConfig -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
enforceLoginPasswordChange![](/images/permalink.svg)
Enforce login password change for all users
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestPasswordPoliciesForPasswordType![](/images/permalink.svg)
function requestPasswordPoliciesForPasswordType(string passwordType, string? xSdsAuthToken) returns PasswordPoliciesConfig|error
Request password policies for a certain password type
Parameters
- passwordType string - Password type
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestAuthConfig![](/images/permalink.svg)
function requestAuthConfig(string? xSdsAuthToken) returns AuthConfig|error
Request authentication settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- AuthConfig|error - OK
updateAuthConfig![](/images/permalink.svg)
function updateAuthConfig(AuthConfig payload, string? xSdsAuthToken) returns AuthConfig|error
Update authentication settings
Return Type
- AuthConfig|error - OK
requestSystemDefaults![](/images/permalink.svg)
function requestSystemDefaults(string? xSdsAuthToken) returns SystemDefaults|error
Request system defaults
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SystemDefaults|error - OK
updateSystemDefaults![](/images/permalink.svg)
function updateSystemDefaults(UpdateSystemDefaults payload, string? xSdsAuthToken) returns SystemDefaults|error
Update system defaults
Return Type
- SystemDefaults|error - OK
requestEventlogConfig![](/images/permalink.svg)
function requestEventlogConfig(string? xSdsAuthToken) returns EventlogConfig|error
Request eventlog settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- EventlogConfig|error - OK
updateEventlogConfig![](/images/permalink.svg)
function updateEventlogConfig(UpdateEventlogConfig payload, string? xSdsAuthToken) returns EventlogConfig|error
Update eventlog settings
Return Type
- EventlogConfig|error - OK
requestGeneralSettings![](/images/permalink.svg)
function requestGeneralSettings(string? xSdsAuthToken) returns GeneralSettings|error
Request general settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- GeneralSettings|error - OK
updateGeneralSettings![](/images/permalink.svg)
function updateGeneralSettings(UpdateGeneralSettings payload, string? xSdsAuthToken) returns GeneralSettings|error
Update general settings
Return Type
- GeneralSettings|error - OK
requestInfrastructureProperties![](/images/permalink.svg)
function requestInfrastructureProperties(string? xSdsAuthToken) returns InfrastructureProperties|error
Request infrastructure properties
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
requestSyslogConfig![](/images/permalink.svg)
function requestSyslogConfig(string? xSdsAuthToken) returns SyslogConfig|error
Request syslog settings
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SyslogConfig|error - OK
updateSyslogConfig![](/images/permalink.svg)
function updateSyslogConfig(UpdateSyslogConfig payload, string? xSdsAuthToken) returns SyslogConfig|error
Update syslog settings
Return Type
- SyslogConfig|error - OK
request3Config![](/images/permalink.svg)
Request S3 storage configuration
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
updateS3Config![](/images/permalink.svg)
function updateS3Config(S3ConfigUpdateRequest payload, string? xSdsAuthToken) returns S3Config|error
Update S3 storage configuration
createS3Config![](/images/permalink.svg)
function createS3Config(S3ConfigCreateRequest payload, string? xSdsAuthToken) returns S3Config|error
Create S3 storage configuration
requestS3TagList![](/images/permalink.svg)
Request list of configured S3 tags
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
createS3Tag![](/images/permalink.svg)
function createS3Tag(S3TagCreateRequest payload, string? xSdsAuthToken) returns S3Tag|error
Create S3 tag
requestS3Tag![](/images/permalink.svg)
Request S3 tag
removeS3Tag![](/images/permalink.svg)
Remove S3 tag
completeFileUploadByToken![](/images/permalink.svg)
function completeFileUploadByToken(string token, CompleteUploadRequest payload, string? xSdsDateFormat) returns Node|error
Complete file upload
Parameters
- token string - Upload token
- payload CompleteUploadRequest - The body must be empty if public upload token is used.
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
uploadfilebytokenasmultipart1![](/images/permalink.svg)
function uploadfilebytokenasmultipart1(string token, UploadsTokenBody payload, string? contentRange) returns ChunkUploadResponse|error
Upload file
Parameters
- token string - Upload token
- payload UploadsTokenBody - File
- contentRange string? (default ()) - Content-Range e.g.
bytes 0-999/3980
Return Type
- ChunkUploadResponse|error - default response
cancelFileUploadByToken![](/images/permalink.svg)
Cancel file upload
Parameters
- token string - Upload token
requestUserInfo![](/images/permalink.svg)
function requestUserInfo(string? xSdsDateFormat, boolean? moreInfo, string? xSdsAuthToken) returns UserAccount|error
Request user account information
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- moreInfo boolean? (default ()) - Get more info for this user e.g. list of user groups
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserAccount|error - OK
updateUserAccount![](/images/permalink.svg)
function updateUserAccount(UpdateUserAccountRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UserAccount|error
Update user account
Parameters
- payload UpdateUserAccountRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserAccount|error - OK
requestAvatar![](/images/permalink.svg)
Request avatar
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
uploadAvatarAsMultipart![](/images/permalink.svg)
function uploadAvatarAsMultipart(AccountAvatarBody payload, string? xSdsAuthToken) returns Avatar|error
Change avatar
resetAvatar![](/images/permalink.svg)
Reset avatar
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestCustomerInfo![](/images/permalink.svg)
function requestCustomerInfo(string? xSdsAuthToken) returns CustomerData|error
Request customer information for user
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- CustomerData|error - OK
enableCustomerEncryption![](/images/permalink.svg)
function enableCustomerEncryption(EnableCustomerEncryptionRequest payload, string? xSdsAuthToken) returns CustomerData|error
Activate client-side encryption for customer
Parameters
- payload EnableCustomerEncryptionRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- CustomerData|error - OK
Deprecated
requestCustomerKeyPair![](/images/permalink.svg)
function requestCustomerKeyPair(string? xSdsAuthToken) returns UserKeyPairContainer|error
Request customer's key pair
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserKeyPairContainer|error - OK
Deprecated
requestUserKeyPair![](/images/permalink.svg)
function requestUserKeyPair(string? xSdsDateFormat, string? 'version, string? xSdsAuthToken) returns UserKeyPairContainer|error
Request user's key pair
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
setUserKeyPair![](/images/permalink.svg)
function setUserKeyPair(UserKeyPairContainer payload, string? xSdsAuthToken) returns Response|error
Set user's key pair
removeUserKeyPair![](/images/permalink.svg)
Remove user's key pair
Parameters
- 'version string? (default ()) - Version (NEW)
- xSdsAuthToken string? (default ()) - Authentication token
requestUserKeyPairs![](/images/permalink.svg)
function requestUserKeyPairs(string? xSdsDateFormat, string? xSdsAuthToken) returns UserKeyPairContainer[]|error
Request all user key pairs
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserKeyPairContainer[]|error - OK
createAndPreserveUserKeyPair![](/images/permalink.svg)
function createAndPreserveUserKeyPair(CreateKeyPairRequest payload, string? xSdsAuthToken) returns Response|error
Create key pair and preserve copy of old private key
changeUserPassword![](/images/permalink.svg)
function changeUserPassword(ChangeUserPasswordRequest payload, string? xSdsAuthToken) returns Response|error
Change user's password
Parameters
- payload ChangeUserPasswordRequest -
- xSdsAuthToken string? (default ()) - Authentication token
logout![](/images/permalink.svg)
Invalidate authentication token
Parameters
- everywhere boolean? (default ()) - Invalidate all tokens
- xSdsAuthToken string? (default ()) - Authentication token
requestListOfNotificationConfigs![](/images/permalink.svg)
function requestListOfNotificationConfigs(string? xSdsAuthToken) returns NotificationConfigList|error
Request list of notification configurations
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
updateNotificationConfig![](/images/permalink.svg)
function updateNotificationConfig(int id, NotificationConfigChangeRequest payload, string? xSdsAuthToken) returns NotificationConfig|error
Update notification configuration
Parameters
- id int - Unique identifier for a notification configuration
- payload NotificationConfigChangeRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- NotificationConfig|error - OK
requestOAuthApprovals![](/images/permalink.svg)
function requestOAuthApprovals(string? xSdsDateFormat, string? sort, string? xSdsAuthToken) returns OAuthApproval[]|error
Request list of OAuth client approvals
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthApproval[]|error - OK
removeOAuthApproval![](/images/permalink.svg)
Remove OAuth client approval
Parameters
- clientId string - OAuth client ID
- xSdsAuthToken string? (default ()) - Authentication token
requestOAuthAuthorizations![](/images/permalink.svg)
function requestOAuthAuthorizations(string? xSdsDateFormat, string? filter, string? sort, string? xSdsAuthToken) returns OAuthAuthorization[]|error
Request list of OAuth client authorizations
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- OAuthAuthorization[]|error - OK
removeOAuthAuthorizations![](/images/permalink.svg)
Remove all OAuth authorizations of a client
Parameters
- clientId string - OAuth client ID
- xSdsAuthToken string? (default ()) - Authentication token
removeOAuthAuthorization![](/images/permalink.svg)
function removeOAuthAuthorization(string clientId, int authorizationId, string? xSdsAuthToken) returns Response|error
Remove a OAuth authorization
Parameters
- clientId string - OAuth client ID
- authorizationId int - OAuth authorization ID
- xSdsAuthToken string? (default ()) - Authentication token
pingUser![](/images/permalink.svg)
(authenticated) Ping
Parameters
- xSdsAuthToken string? (default ()) - Authentication token
requestProfileAttributes![](/images/permalink.svg)
function requestProfileAttributes(int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns AttributesResponse|error
Request user profile attributes
Parameters
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- AttributesResponse|error - OK
updateProfileAttributes![](/images/permalink.svg)
function updateProfileAttributes(ProfileAttributesRequest payload, string? xSdsAuthToken) returns ProfileAttributes|error
Add or edit user profile attributes
Parameters
- payload ProfileAttributesRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- ProfileAttributes|error - OK
setProfileAttributes![](/images/permalink.svg)
function setProfileAttributes(ProfileAttributesRequest payload, string? xSdsAuthToken) returns ProfileAttributes|error
Set user profile attributes
Parameters
- payload ProfileAttributesRequest -
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- ProfileAttributes|error - Created
Deprecated
removeProfileAttribute![](/images/permalink.svg)
Remove user profile attribute
listDownloadShareSubscriptions![](/images/permalink.svg)
function listDownloadShareSubscriptions(string? filter, int? 'limit, int? offset, string? sort, string? xSdsAuthToken) returns SubscribedDownloadShareList|error
List Download Share subscriptions
Parameters
- filter string? (default ()) - Filter string
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- offset int? (default ()) - Range offset
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
subscribeDownloadShares![](/images/permalink.svg)
function subscribeDownloadShares(UpdateSubscriptionsBulkRequest payload, string? xSdsAuthToken) returns Response|error
Subscribe or Unsubscribe a List of Download Shares for notifications
Parameters
- payload UpdateSubscriptionsBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
subscribeDownloadShare![](/images/permalink.svg)
function subscribeDownloadShare(int shareId, string? xSdsAuthToken) returns SubscribedDownloadShare|error
Subscribe Download Share for notifications
Return Type
- SubscribedDownloadShare|error - Created
unsubscribeDownloadShare![](/images/permalink.svg)
Unsubscribe Download Share from notifications
listNodeSubscriptions![](/images/permalink.svg)
function listNodeSubscriptions(string? filter, int? 'limit, int? offset, string? sort, string? xSdsAuthToken) returns SubscribedNodeList|error
List node subscriptions
Parameters
- filter string? (default ()) - Filter string
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- offset int? (default ()) - Range offset
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- SubscribedNodeList|error - OK
updateNodeSubscriptions![](/images/permalink.svg)
function updateNodeSubscriptions(UpdateSubscriptionsBulkRequest payload, string? xSdsAuthToken) returns Response|error
Subscribe or Unsubscribe a List of nodes for notifications
Parameters
- payload UpdateSubscriptionsBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
subscribeNode![](/images/permalink.svg)
function subscribeNode(int nodeId, string? xSdsAuthToken) returns SubscribedNode|error
Subscribe node for notifications
Return Type
- SubscribedNode|error - Created
unsubscribeNode![](/images/permalink.svg)
Unsubscribe node from notifications
listUploadShareSubscriptions![](/images/permalink.svg)
function listUploadShareSubscriptions(string? filter, int? 'limit, int? offset, string? sort, string? xSdsAuthToken) returns SubscribedUploadShareList|error
List Upload Share subscriptions
Parameters
- filter string? (default ()) - Filter string
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- offset int? (default ()) - Range offset
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
subscribeUploadShares![](/images/permalink.svg)
function subscribeUploadShares(UpdateSubscriptionsBulkRequest payload, string? xSdsAuthToken) returns Response|error
Subscribe or Unsubscribe a List of Upload Shares for notifications
Parameters
- payload UpdateSubscriptionsBulkRequest -
- xSdsAuthToken string? (default ()) - Authentication token
subscribeUploadShare![](/images/permalink.svg)
function subscribeUploadShare(int shareId, string? xSdsAuthToken) returns SubscribedUploadShare|error
Subscribe Upload Share for notifications
Return Type
- SubscribedUploadShare|error - Created
unsubscribeUploadShare![](/images/permalink.svg)
Unsubscribe Upload Share from notifications
requestUsers![](/images/permalink.svg)
function requestUsers(string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? sort, boolean? includeAttributes, boolean? includeRoles, boolean? includeManageableRooms, string? xSdsAuthToken) returns UserList|error
Request users
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- includeAttributes boolean? (default ()) - Include custom user attributes.
- includeRoles boolean? (default ()) - Include roles
- includeManageableRooms boolean? (default ()) - Include hasManageableRooms (deprecated)
- xSdsAuthToken string? (default ()) - Authentication token
createUser![](/images/permalink.svg)
function createUser(CreateUserRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UserData|error
Create new user
Parameters
- payload CreateUserRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
requestUser![](/images/permalink.svg)
function requestUser(int userId, string? xSdsDateFormat, boolean? effectiveRoles, string? xSdsAuthToken) returns UserData|error
Request user
Parameters
- userId int - User ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- effectiveRoles boolean? (default ()) - Filter users with DIRECT or DIRECT AND EFFECTIVE roles. *
false
: DIRECT roles *true
: DIRECT AND EFFECTIVE roles DIRECT means: e.g. user gets role directly granted from someone with grant permission right. EFFECTIVE means: e.g. user gets role through group membership.
- xSdsAuthToken string? (default ()) - Authentication token
updateUser![](/images/permalink.svg)
function updateUser(int userId, UpdateUserRequest payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UserData|error
Update user's metadata
Parameters
- userId int - User ID
- payload UpdateUserRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeUser![](/images/permalink.svg)
Remove user
requestUserGroups![](/images/permalink.svg)
function requestUserGroups(int userId, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns UserGroupList|error
Request groups that user is a member of or / and can become a member
Parameters
- userId int - User ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- UserGroupList|error - OK
requestLastAdminRoomsUsers![](/images/permalink.svg)
function requestLastAdminRoomsUsers(int userId, string? xSdsAuthToken) returns LastAdminUserRoomList|error
Request rooms where the user is last admin
Return Type
requestUserRoles![](/images/permalink.svg)
Request user's granted roles
requestUsersRooms![](/images/permalink.svg)
function requestUsersRooms(int userId, string? xSdsDateFormat, int? offset, int? 'limit, string? filter, string? xSdsAuthToken) returns RoomTreeDataList|error
Request rooms granted to the user or / and rooms that can be granted
Parameters
- userId int - User ID
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- RoomTreeDataList|error - OK
Deprecated
requestUserAttributes![](/images/permalink.svg)
function requestUserAttributes(int userId, int? offset, int? 'limit, string? filter, string? sort, string? xSdsAuthToken) returns AttributesResponse|error
Request custom user attributes
Parameters
- userId int - User ID
- offset int? (default ()) - Range offset
- 'limit int? (default ()) - Range limit. Maximum 500. For more results please use paging (
offset
+limit
).
- filter string? (default ()) - Filter string
- sort string? (default ()) - Sort string
- xSdsAuthToken string? (default ()) - Authentication token
Return Type
- AttributesResponse|error - OK
updateUserAttributes![](/images/permalink.svg)
function updateUserAttributes(int userId, UserAttributes payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UserData|error
Add or edit custom user attributes
Parameters
- userId int - User ID
- payload UserAttributes -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
setUserAttributes![](/images/permalink.svg)
function setUserAttributes(int userId, UserAttributes payload, string? xSdsDateFormat, string? xSdsAuthToken) returns UserData|error
Set custom user attributes
Parameters
- userId int - User ID
- payload UserAttributes -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- xSdsAuthToken string? (default ()) - Authentication token
removeUserAttribute![](/images/permalink.svg)
Remove custom user attribute
Records![](/images/permalink.svg)
dracoon.public: AccessKeyUploadIdBody![](/images/permalink.svg)
Fields
- file string? -
dracoon.public: AccountAvatarBody![](/images/permalink.svg)
Fields
- file string? -
dracoon.public: ActiveDirectory![](/images/permalink.svg)
Active Directory information
Fields
- alias string - Unique name for an Active Directory configuration
- id int - ID
- isGlobalAvailable boolean - Is available for all customers
dracoon.public: ActiveDirectoryAuthInfo![](/images/permalink.svg)
List of Active Directories
Fields
- items ActiveDirectory[] - List of available Active Directories
dracoon.public: ActiveDirectoryConfig![](/images/permalink.svg)
Active Directory configuration
Fields
- adExportGroup string - If
userImport
is set totrue
, the user must be member of this Active Directory group to receive a newly created DRACOON account.
- alias string - Unique name for an Active Directory configuration
- createHomeFolder boolean(default false) - Deprecated since v4.10.0 DEPRECATED, will be ignored Determines whether a room is created for each user that is created by automatic import (like a home folder). Room's name will equal the user's login name.
- homeFolderParent int? - Deprecated since v4.10.0 DEPRECATED, will be ignored ID of the room in which the individual rooms for users will be created.
- id int - ID
- ldapUsersDomain string - Search scope of Active Directory; only users below this node can log on.
- sdsImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- serverAdminName string - Distinguished Name (DN) of Active Directory administrative account
- serverIp string - IPv4 or IPv6 address or host name
- serverPort int - Port
- sslFingerPrint string? - SSL finger print of Active Directory server.
Mandatory for LDAPS connections.
Format:
Algorithm/Fingerprint
- useLdaps boolean - Determines whether LDAPS should be used instead of plain LDAP.
- userFilter string - Name of Active Directory attribute that is used as login name.
- userImport boolean - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
dracoon.public: ActiveDirectoryConfigList![](/images/permalink.svg)
List of Active Directory configurations
Fields
- items ActiveDirectoryConfig[] - List of Active Directory configurations
dracoon.public: AlgorithmVersionInfo![](/images/permalink.svg)
Algorithm information
Fields
- description string - Algorithm description
- status string - Algorithm status Derived from preference value and threshold
- 'version string - Algorithm version
dracoon.public: AlgorithmVersionInfoList![](/images/permalink.svg)
Information of all available algorithms
Fields
- fileKeyAlgorithms AlgorithmVersionInfo[] - List of file key algorithms
- keyPairAlgorithms AlgorithmVersionInfo[] - List of key pair algorithms
dracoon.public: AttributesResponse![](/images/permalink.svg)
Ranged list of attributes
Fields
- items KeyValueEntry[] - List of key-value pairs
- range Range - Range information
dracoon.public: AuditNodeResponse![](/images/permalink.svg)
Audit node report
Fields
- auditUserPermissionList AuditUserPermission[] - List of assigned users with permissions
- nodeCntChildren int - Number of direct children (no recursion; for rooms only)
- nodeCreatedAt string? - Creation date
- nodeCreatedBy UserInfo? - User information
- nodeHasActivitiesLog boolean(default true) - Is activities log active (for rooms only)
- nodeHasRecycleBin boolean? - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- nodeId int - Node ID
- nodeIsEncrypted boolean? - Encryption state
- nodeName string - Node name
- nodeParentId int? - Parent node ID (room or folder)
- nodeParentPath string - Parent node path
/
if node is a root node (room)
- nodeQuota int? - Quota in byte
- nodeRecycleBinRetentionPeriod int? - Retention period for deleted nodes in days
- nodeSize int? - Node size in byte
- nodeUpdatedAt string? - Modification date
- nodeUpdatedBy UserInfo? - User information
dracoon.public: AuditUserPermission![](/images/permalink.svg)
Audit user permissions report
Fields
- permissions NodePermissions - Node permissions
- userFirstName string - User first name
- userId int - Unique identifier for the user
- userLastName string - User last name
- userLogin string - User login name
dracoon.public: AuthConfig![](/images/permalink.svg)
Authentication settings
Fields
- authMethods AuthMethod[] - List of authentication methods
dracoon.public: AuthMethod![](/images/permalink.svg)
Authentication method
Fields
- isEnabled boolean - Is enabled
- name string - Authentication methods:
-
basic
-
active_directory
-
radius
-
openid
-
- priority int - Priority (smaller values have higher priority)
dracoon.public: AuthTokenRestrictions![](/images/permalink.svg)
Auth token restrictions
Fields
- accessTokenValidity int? - Since v4.13.0 Restricted OAuth access token validity (in seconds)
- refreshTokenValidity int? - Since v4.13.0 Restricted OAuth refresh token validity (in seconds)
- restrictionEnabled boolean? - Since v4.13.0 Defines if OAuth token restrictions are enabled
dracoon.public: Avatar![](/images/permalink.svg)
User avatar information
Fields
- avatarUri string - Avatar URI
- avatarUuid string - Avatar UUID
- isCustomAvatar boolean - Determines whether user updated his / her avatar with own image
dracoon.public: ChangeGroupMembersRequest![](/images/permalink.svg)
List of user IDs
Fields
- ids int[] - List of user IDs
dracoon.public: ChangeNodeCommentRequest![](/images/permalink.svg)
Request model for updating a node comment
Fields
- text string - Comment text
dracoon.public: ChangeUserPasswordRequest![](/images/permalink.svg)
Request model for updating user's password
Fields
- newPassword string - New password
- oldPassword string - Old password
dracoon.public: CharacterRules![](/images/permalink.svg)
Password character rules
Fields
- mustContainCharacters string[] - Characters which a password must contain:
-
alpha
- at least one alphabetical character (uppercase
ORlowercase
) -
uppercase
- at least one uppercase character -
lowercase
- at least one lowercase character -
numeric
- at least one numeric character -
special
- at least one special character (letters and digits excluded) -
all
- combination ofuppercase
,lowercase
,numeric
andspecial
(available only in request models) -
none
- none of the above
-
- numberOfCharacteristicsToEnforce int - Number of characteristics to enforce
e.g. from
["uppercase", "lowercase", "numeric", "special"]
all 4 character sets can be enforced; but also only 2 of them
dracoon.public: ChunkUploadResponse![](/images/permalink.svg)
Chunk upload response
Fields
- hash string - Hash value of transferred chunk
- size int - Chunk size
dracoon.public: ClientConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_1_1) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
- proxy ProxyConfig?(default ()) - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
dracoon.public: Comment![](/images/permalink.svg)
Node comment information
Fields
- createdAt string - Creation date
- createdBy UserInfo - User information
- id int - Comment ID
- isChanged boolean - Determines whether comment was edited or not
- isDeleted boolean - Determines whether comment was deleted or not
- text string - Comment text
- updatedAt string - Modification date
- updatedBy UserInfo - User information
dracoon.public: CommentList![](/images/permalink.svg)
List of node comments
Fields
- items Comment[] - List of node comments
- range Range - Range information
dracoon.public: CompleteS3FileUploadRequest![](/images/permalink.svg)
Request model for completing a S3 file upload
Fields
- fileKey FileKey? - File key information
- fileName string? - New file name to store with
- keepShareLinks boolean(default false) - Preserve Download Share Links and point them to the new node.
- parts S3FileUploadPart[] - List of S3 file upload parts
- resolutionStrategy string(default "autorename") - Node conflict resolution strategy:
-
autorename
-
overwrite
-
fail
-
dracoon.public: CompleteS3ShareUploadRequest![](/images/permalink.svg)
Request model for completing a S3 file upload
Fields
- parts S3FileUploadPart[] - List of S3 file upload parts
- userFileKeyList UserFileKey[]? - List of user file keys
dracoon.public: CompleteUploadRequest![](/images/permalink.svg)
Request model for completing an upload
Fields
- fileKey FileKey? - File key information
- fileName string? - New file name to store with
- keepShareLinks boolean? - Preserve Download Share Links and point them to the new node.
- resolutionStrategy string? - Node conflict resolution strategy:
-
autorename
-
overwrite
-
fail
-
- userFileKeyList UserFileKeyList? - List of user file keys
dracoon.public: ConfigOptionList![](/images/permalink.svg)
List of key-value pairs
Fields
- items KeyValueEntry[] - List of key-value pairs
dracoon.public: ConfigRoomRequest![](/images/permalink.svg)
Request model for configuring a room
Fields
- adminGroupIds int[]? - List of group ids A room requires at least one admin (user or group)
- adminIds int[]? - List of user ids A room requires at least one admin (user or group)
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- hasActivitiesLog boolean? - Is activities log active (for rooms only)
- hasRecycleBin boolean? - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- inheritPermissions boolean? - Inherit permissions from parent room
(default:
false
ifparentId
is0
; otherwise:true
)
- newGroupMemberAcceptance string? - Behaviour when new users are added to the group:
-
autoallow
-
pending
adminGroupIds
has items. -
- recycleBinRetentionPeriod int? - Retention period for deleted nodes in days
- takeOverPermissions boolean? - Take over existing permissions
dracoon.public: CopyNode![](/images/permalink.svg)
Copied node information
Fields
- id int - Source node ID
- name string? - New node name
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CopyNodesRequest![](/images/permalink.svg)
Request model for copying nodes
Fields
- items CopyNode[]? - List of nodes to be copied
- keepShareLinks boolean? - Preserve Download Share Links and point them to the new node.
- nodeIds int[]? - Deprecated since v4.5.0
Node IDs
Please use
items
instead.
- resolutionStrategy string? - Node conflict resolution strategy:
-
autorename
-
overwrite
-
fail
-
dracoon.public: CreateActiveDirectoryConfigRequest![](/images/permalink.svg)
Request model for creating an Active Directory configuration
Fields
- adExportGroup string? - If
userImport
is set totrue
, the user must be member of this Active Directory group to receive a newly created DRACOON account.
- alias string - Unique name for an Active Directory configuration
- createHomeFolder boolean(default false) - DEPRECATED, will be ignored Determines whether a room is created for each user that is created by automatic import (like a home folder). Room's name will equal the user's login name.
- homeFolderParent int? - DEPRECATED, will be ignored ID of the room in which the individual rooms for users will be created.
- ldapUsersDomain string - Search scope of Active Directory; only users below this node can log on.
- sdsImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- serverAdminName string - Distinguished Name (DN) of Active Directory administrative account
- serverAdminPassword string - Password of Active Directory administrative account
- serverIp string - IPv4 or IPv6 address or host name
- serverPort int - Port
- sslFingerPrint string? - SSL finger print of Active Directory server.
Mandatory for LDAPS connections.
Format:
Algorithm/Fingerprint
- useLdaps boolean(default false) - Determines whether LDAPS should be used instead of plain LDAP.
- userFilter string - Name of Active Directory attribute that is used as login name.
- userImport boolean(default false) - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
dracoon.public: CreateDownloadShareRequest![](/images/permalink.svg)
Request model for creating a Download Share
Fields
- creatorLanguage string? - Deprecated since v4.20.0 Language tag for messages to creator
- expiration ObjectExpiration? - Expiration information
- fileKey FileKey? - File key information
- internalNotes string? - Since v4.11.0 Internal notes
- keyPair UserKeyPairContainer? - Key pair container
- mailBody string? - Deprecated since v4.11.0 Notification email content
- mailRecipients string? - Deprecated since v4.11.0 CSV string of recipient email addresses
- mailSubject string? - Deprecated since v4.11.0 Notification email subject
- maxDownloads int? - Max allowed downloads
- name string? - Alias name (default: name of the shared node)
- nodeId int - Source node ID
- notes string? - User notes
- notifyCreator boolean(default false) - Deprecated since v4.20.0 Notify creator on every download.
- password string? - Access password, not allowed for encrypted shares
- receiverLanguage string? - Language tag for messages to receiver
- sendMail boolean(default false) - Deprecated since v4.11.0
Notify recipients via email
Please use
POST /shares/downloads/{share_id}/email
API instead.
- sendSms boolean(default false) - Deprecated since v4.11.0
Send share password via SMS
Please use
textMessageRecipients
attribute instead.
- showCreatorName boolean(default false) - Show creator first and last name.
- showCreatorUsername boolean(default false) - Show creator email address.
- smsRecipients string? - Deprecated since v4.11.0 CSV string of recipient MSISDNs
- textMessageRecipients string[]? - Since v4.11.0 List of recipient FQTNs E.123 / E.164 Format
dracoon.public: CreateFileUploadRequest![](/images/permalink.svg)
Request model for creating an upload channel
Fields
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- directS3Upload boolean(default false) - Since v4.15.0 Upload direct to S3
- expiration ObjectExpiration? - Expiration information
- name string - File name
- notes string? - User notes Use empty string to remove.
- parentId int - Parent node ID (room or folder)
- size int? - File size in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CreateFileUploadResponse![](/images/permalink.svg)
Upload channel information
Fields
- token string - Deprecated since v4.3.0 Upload token
- uploadId string - Upload (channel) ID
- uploadUrl string - (public) Upload URL
dracoon.public: CreateFolderRequest![](/images/permalink.svg)
Request model for creating a folder
Fields
- name string - Name
- notes string? - User notes Use empty string to remove.
- parentId int - Parent node ID (room or folder)
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CreateGroupRequest![](/images/permalink.svg)
Request model for creating a group
Fields
- expiration ObjectExpiration? - Expiration information
- name string - Group name
dracoon.public: CreateKeyPairRequest![](/images/permalink.svg)
Request model for creating a key pair
Fields
- previousPrivateKey PrivateKeyContainer - Private key container
- privateKeyContainer PrivateKeyContainer - Private key container
- publicKeyContainer PublicKeyContainer - Public key container
dracoon.public: CreateNodeCommentRequest![](/images/permalink.svg)
Request model for creating a node comment
Fields
- text string - Comment text
dracoon.public: CreateOAuthClientRequest![](/images/permalink.svg)
Request model for creating an OAuth client
Fields
- accessTokenValidity int? - Validity of the access token in seconds.
- approvalValidity int? - Since v4.22.0 Validity of the approval interval in seconds.
- clientId string? - ID of the OAuth client
- clientName string - Name, which is shown at the client configuration and authorization.
- clientSecret string? - Secret, which client uses at authentication.
- clientType string? - Determines whether client is a confidential or public client.
- redirectUris string[]? - URIs, to which a user is redirected after authorization.
- refreshTokenValidity int? - Validity of the refresh token in seconds.
dracoon.public: CreateOpenIdIdpConfigRequest![](/images/permalink.svg)
Request model for creating an OpenID Connect IDP configuration
Fields
- authorizationEndPointUrl string - URL of the authorization endpoint
- clientId string - ID of the OpenID client
- clientSecret string - Secret, which client uses at authentication.
- fallbackMappingClaim string? - Name of the claim which is used for the user mapping fallback.
- flow string? - Since v4.11.0 Flow, which is used at authentication
- issuer string - Issuer identifier of the IDP The value is a case sensitive URL.
- jwksEndPointUrl string - URL of the JWKS endpoint
- mappingClaim string - Name of the claim which is used for the user mapping.
- name string - Name of the IDP
- redirectUris string[] - URIs, to which a user is redirected after authorization.
- scopes string[] - List of requested scopes
- tokenEndPointUrl string - URL of the token endpoint
- userImportEnabled boolean(default false) - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
- userImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- userInfoEndPointUrl string - URL of the user info endpoint
- userInfoSource string? - Since v4.23.0 Source, which is used to get user information at the import or update of a user.
- userManagementUrl string? - URL of the user management UI. Use empty string to remove.
- userUpdateEnabled boolean(default false) - Determines if the DRACOON account is updated with data from AD / IDP.
For OpenID Connect, the scopes
email
andprofile
are needed.
dracoon.public: CreateRoomRequest![](/images/permalink.svg)
Request model for creating a room
Fields
- adminGroupIds int[]? - List of group ids A room requires at least one admin (user or group)
- adminIds int[]? - List of user ids A room requires at least one admin (user or group)
- classification int(default 2) - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- hasActivitiesLog boolean(default true) - Is activities log active (for rooms only)
- hasRecycleBin boolean? - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- inheritPermissions boolean? - Inherit permissions from parent room
(default:
false
ifparentId
is0
; otherwise:true
)
- name string - Name
- newGroupMemberAcceptance string(default "autoallow") - Behaviour when new users are added to the group:
-
autoallow
-
pending
adminGroupIds
has items. -
- notes string? - User notes Use empty string to remove.
- parentId int? - Parent room ID or
null
(not 0) to create a top level room
- quota int? - Quota in byte
- recycleBinRetentionPeriod int? - Retention period for deleted nodes in days
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CreateShareUploadChannelRequest![](/images/permalink.svg)
Request model for creating an upload channel
Fields
- directS3Upload boolean(default false) - Since v4.15.0 Upload direct to S3
- name string - File name
- password string? - Password
- size int? - File size in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CreateShareUploadChannelResponse![](/images/permalink.svg)
Upload channel information
Fields
- token string? - Deprecated since v4.3.0 Upload token
- uploadId string - Upload (channel) ID
- uploadUrl string - (public) Upload URL
dracoon.public: CreateUploadShareRequest![](/images/permalink.svg)
Request model for creating an Upload Share
Fields
- creatorLanguage string? - Deprecated since v4.20.0 Language tag for messages to creator
- expiration ObjectExpiration? - Expiration information
- filesExpiryPeriod int? - Number of days after which uploaded files expire
- internalNotes string? - Since v4.11.0 Internal notes
- mailBody string? - Deprecated since v4.11.0 Notification email content
- mailRecipients string? - Deprecated since v4.11.0 CSV string of recipient email addresses
- mailSubject string? - Deprecated since v4.11.0 Notification email subject
- maxSize int? - Maximal total size of uploaded files (in bytes)
- maxSlots int? - Maximal amount of files to upload
- name string? - Alias name (default: name of the shared node)
- notes string? - User notes
- notifyCreator boolean(default false) - Deprecated since v4.20.0 Notify creator on every upload.
- password string? - Password
- receiverLanguage string? - Language tag for messages to receiver
- sendMail boolean(default false) - Deprecated since v4.11.0
Notify recipients via email
Please use
POST /shares/uploads/{share_id}/email
API instead.
- sendSms boolean(default false) - Deprecated since v4.11.0
Send share password via SMS
Please use
textMessageRecipients
attribute instead.
- showCreatorName boolean(default false) - Since v4.11.0 Show creator first and last name.
- showCreatorUsername boolean(default false) - Since v4.11.0 Show creator email address.
- showUploadedFiles boolean(default false) - Allow display of already uploaded files
- smsRecipients string? - Deprecated since v4.11.0 CSV string of recipient MSISDNs
- targetId int - Target room or folder ID
- textMessageRecipients string[]? - Since v4.11.0 List of recipient FQTNs E.123 / E.164 Format
dracoon.public: CreateUserRequest![](/images/permalink.svg)
Request model for creating an user
Fields
- authData UserAuthData? - User Authentication Data
- authMethods UserAuthMethod[]? - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- email string? - Email
- expiration ObjectExpiration? - Expiration information
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0
Gender
Do NOT use
gender
! It will be ignored.
- isNonmemberViewer boolean? - Since v4.12.0 Determines whether user has the role NONMEMBER_VIEWER
- lastName string - User last name
- login string? - Deprecated since v4.13.0 User login name
- needsToChangePassword boolean? - Deprecated since v4.13.0
Determines whether user has to change his / her initial password.
use
authDate.mustChangePassword
instead
- notifyUser boolean? - Since v4.9.0
Notify user about his new account
-
default:
true
forbasic
auth type -
default:
false
foractive_directory
,openid
andradius
auth types
-
default:
- password string? - Deprecated since v4.13.0
An initial password may be preset
use
authData
instead
- phone string? - Phone number
- receiverLanguage string? - IETF language tag
- title string? - Deprecated since v4.18.0 Job title
- userName string? - Since v4.13.0 Username
dracoon.public: CreateWebhookRequest![](/images/permalink.svg)
Request model for creating a webhook
Fields
- eventTypeNames string[] - List of names of event types
- isEnabled boolean? - Is enabled
- name string - Name
- secret string? - Secret; used for event message signatures
- triggerExampleEvent boolean? - If set to true, an example event is being created
- url string - URL (must begin with the
HTTPS
scheme)
dracoon.public: Customer![](/images/permalink.svg)
Customer information
Fields
- activationCode string? - Deprecated since v4.8.0
Customer activation code string:
-
valid only for types
free
anddemo
-
for
pay
customers it is empty
-
valid only for types
- companyName string - Company name
- createdAt string - Creation date
- customerAttributes CustomerAttributes? - List of customer attributes
- customerContractType string - Customer type
- customerUuid string - Since v4.21.0 Customer UUID
- id int - Unique identifier for the customer
- isLocked boolean(default false) - Customer is locked:
-
false
- unlocked -
true
- locked
-
- lastLoginAt string? - Date of last seen login for the customer
- lockStatus boolean - Deprecated since v4.7.0
Customer lock status:
-
false
- unlocked -
true
- locked
isLocked
instead. All users of this customer will be blocked and can not login anymore. -
- providerCustomerId string? - Provider customer ID
- quotaMax int - Maximal disc space which can be allocated by customer in bytes. -1 for unlimited
- quotaUsed int - Used amount of disc space in bytes
- trialDaysLeft int? - Number of days left for trial period (relevant only for type
demo
) (not used)
- updatedAt string? - Modification date
- userMax int - Maximal number of users
- userUsed int - Number of users which are already allocated.
- webhooksMax int? - Since v4.19.0 Maximal number of webhooks
dracoon.public: CustomerAttributes![](/images/permalink.svg)
List of customer attributes
Fields
- items KeyValueEntry[] - List of customer attributes
dracoon.public: CustomerData![](/images/permalink.svg)
Customer information
Fields
- accountsLimit int - User accounts limit
- accountsUsed int - User accounts used
- cntFiles int? - Deprecated since v4.11.0 Total number of files Visible only with at least one global role.
- cntFolders int? - Deprecated since v4.11.0 Total number of folders Visible only with at least one global role.
- cntRooms int? - Deprecated since v4.11.0 Total number of rooms Visible only with at least one global role.
- customerEncryptionEnabled boolean - Clientside encryption for customer enabled
- id int - Unique identifier for the customer
- isProviderCustomer boolean - Customer is Provider Customer
- name string - Customer name
- spaceLimit int - Space limit (in bytes). -1 for unlimited
- spaceUsed int - Space used (in bytes)
dracoon.public: CustomerList![](/images/permalink.svg)
List of customers
Fields
- items Customer[] - List of customers
- range Range - Range information
dracoon.public: CustomerSettingsRequest![](/images/permalink.svg)
Request model for setting the customer settings
Fields
- homeRoomParentName string? - Homeroom Parent Name
- homeRoomQuota int? - Homeroom Quota in bytes
- homeRoomsActive boolean? - Homerooms active
dracoon.public: CustomerSettingsResponse![](/images/permalink.svg)
Customer settings
Fields
- homeRoomParentId int? - Homeroom Parent ID
- homeRoomParentName string? - Homeroom Parent Name
- homeRoomQuota int? - Homeroom Quota in bytes
- homeRoomsActive boolean - Homerooms active
dracoon.public: DeleteDeletedNodesRequest![](/images/permalink.svg)
Request model for deleting nodes from recycle bin
Fields
- deletedNodeIds int[] - List of deleted node IDs
dracoon.public: DeletedNode![](/images/permalink.svg)
Deleted node information (Deleted node can be a folder or file)
Fields
- accessedAt string? - Last access date
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- createdAt string? - Creation date
- createdBy UserInfo? - User information
- deletedAt string? - Deletion date
- deletedBy UserInfo? - User information
- expireAt string? - Expiration date
- id int? - Node ID
- isEncrypted boolean? - Encryption state
- name string - Node name
- notes string? - User notes
- parentId int - Parent node ID (room or folder)
- parentPath string - Parent node path
/
if node is a root node (room)
- size int? - Node size in byte
- 'type string - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: DeletedNodeSummary![](/images/permalink.svg)
Deleted node information (Deleted node can be a folder or file)
Fields
- cntVersions int - Number of deleted versions of this file
- firstDeletedAt string - First deleted version
- lastDeletedAt string - Last deleted version
- lastDeletedNodeId int - Node ID of last deleted version
- name string - Node name
- parentId int - Parent node ID (room or folder)
- parentPath string - Parent node path
/
if node is a root node (room)
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system
- 'type string - Node type
dracoon.public: DeletedNodeSummaryList![](/images/permalink.svg)
List of deleted nodes
Fields
- items DeletedNodeSummary[] - List of deleted nodes (summary)
- range Range - Range information
dracoon.public: DeletedNodeVersionsList![](/images/permalink.svg)
List of deleted versions of nodes
Fields
- items DeletedNode[] - List of deleted nodes
- range Range - Range information
dracoon.public: DeleteDownloadSharesRequest![](/images/permalink.svg)
Request model for deleting Download Shares
Fields
- shareIds int[] - List of share IDs
dracoon.public: DeleteNodesRequest![](/images/permalink.svg)
Request model for deleting nodes
Fields
- nodeIds int[] - List of node IDs
dracoon.public: DeleteUploadSharesRequest![](/images/permalink.svg)
Request model for deleting Upload Shares
Fields
- shareIds int[] - List of share IDs
dracoon.public: DownloadShare![](/images/permalink.svg)
Download Share information
Fields
- accessKey string - Share access key to generate secure link
- classification int? - Deprecated since v4.11.0
Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- cntDownloads int - Downloads counter (incremented on each download)
- createdAt string - Creation date
- createdBy UserInfo - User information
- dataUrl string? - Path to shared download node
- expireAt string? - Expiration date
- id int - Share ID
- internalNotes string? - Since v4.11.0 Internal notes
- isEncrypted boolean? - Encrypted share (this only applies to shared files, not folders)
- isProtected boolean? - Is share protected by password
- maxDownloads int? - Max allowed downloads
- name string - Alias name
- nodeId int - Source node ID
- nodePath string? - Path to shared download node
- nodeType string? - Node type
- notes string? - User notes
- notifyCreator boolean - Deprecated since v4.20.0 Notify creator on every download.
- recipients string? - Deprecated since v4.11.0 CSV string of recipient email addresses
- showCreatorName boolean? - Show creator first and last name.
- showCreatorUsername boolean? - Show creator email address.
- smsRecipients string? - Deprecated since v4.11.0 CSV string of recipient MSISDNs
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: DownloadShareLinkEmail![](/images/permalink.svg)
Request model for sending an email of a Download Share link
Fields
- body string - Notification email content
- receiverLanguage string? - Language tag for messages to receiver
- recipients string[] - List of recipient email addresses
dracoon.public: DownloadShareList![](/images/permalink.svg)
List of Download Shares
Fields
- items DownloadShare[] - List of Download Shares
- range Range - Range information
dracoon.public: DownloadTokenGenerateResponse![](/images/permalink.svg)
Download URL
Fields
- downloadUrl string - Download URL
- token string - Deprecated since v4.3.0 Download token
dracoon.public: EnableCustomerEncryptionRequest![](/images/permalink.svg)
Request model for enabling customer encryption
Fields
- dataSpaceRescueKey UserKeyPairContainer - Key pair container
- enableCustomerEncryption boolean - Set
true
to enable encryption for this customer
dracoon.public: EncryptionInfo![](/images/permalink.svg)
Encryption states
Fields
- dataSpaceKeyState string - DRACOON key state
- roomKeyState string - Room key state
- userKeyState string - User key state
dracoon.public: EncryptionPasswordPolicies![](/images/permalink.svg)
Encryption password policies
Fields
- characterRules CharacterRules? - Password character rules
- minLength int? - Minimum number of characters a password must contain
- rejectKeyboardPatterns boolean? - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean? - Determines whether a password must NOT contain user info (first name, last name, email, user name)
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: EncryptRoomRequest![](/images/permalink.svg)
Request model for handling encryption settings for a room
Fields
- dataRoomRescueKey UserKeyPairContainer? - Key pair container
- isEncrypted boolean - Encryption state
- useDataSpaceRescueKey boolean? - Use system emergency password (rescue key) for files in this room
dracoon.public: ErrorResponse![](/images/permalink.svg)
Error information
Fields
- code int - HTTP status code
- debugInfo string? - Debug information
- errorCode int? - Internal error code
- message string - HTTP status code description
dracoon.public: EventlogConfig![](/images/permalink.svg)
Eventlog settings
Fields
- enabled boolean? - Is eventlog enabled?
- logIpEnabled boolean? - Determines whether user’s IP address is logged.
- retentionPeriod int? - Retention period (in days) of event log entries. After that period, all entries are deleted. Recommended value: 7
dracoon.public: EventType![](/images/permalink.svg)
Event type information
Fields
- id int - ID
- name string - Name
- usableCustomerAdminWebhook boolean - Usable as customer admin webhook
- usableNodeWebhook boolean - Usable as node webhook
- usablePushNotification boolean - Usable as push notification
- usableTenantWebhook boolean - Usable as tenant webhook
dracoon.public: EventTypeList![](/images/permalink.svg)
List of event types
Fields
- items EventType[] - List of event types
dracoon.public: FailoverServer![](/images/permalink.svg)
Failover server information
Fields
- failoverEnabled boolean - RADIUS Failover Server is active
- failoverIpAddress string - RADIUS Failover Server IP Address Required if failover server is enabled.
- failoverPort int - RADIUS Failover Server Port Required if failover server is enabled.
dracoon.public: FileFileKeys![](/images/permalink.svg)
File key information
Fields
- fileKeyContainer FileKeyContainer? - File key container
- id int? - File ID
dracoon.public: FileKey![](/images/permalink.svg)
File key information
Fields
- iv string - Initial vector
- 'key string - Encryption key
- tag string - Authentication tag (needed with authenticated encryption)
- 'version string - Version
dracoon.public: FileKeyContainer![](/images/permalink.svg)
File key container
Fields
- iv string - Initial vector
- 'key string - Encryption key
- tag string? - Authentication tag (needed with authenticated encryption)
- 'version string - Version
dracoon.public: FirstAdminUser![](/images/permalink.svg)
First administrator user
Fields
- authData UserAuthData? - User Authentication Data
- authMethods UserAuthMethod[]? - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- email string? - Email
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0 Gender
- language string? - Deprecated since v4.7.0 Language ID or ISO 639-1 code
- lastName string - User last name
- login string? - Deprecated since v4.13.0 User login name
- needsToChangePassword boolean? - Deprecated since v4.13.0
Determines whether user has to change his / her initial password.
use
authDate.mustChangePassword
instead
- needsToChangeUserName boolean(default false) - Deprecated since v4.13.0
If
true
, the user must change theuserName
at the first login.
- notifyUser boolean? - Notify user about his new account
-
default:
true
forbasic
auth type -
default:
false
foractive_directory
,openid
andradius
auth types
-
default:
- password string? - Deprecated since v4.13.0
An initial password may be preset
use
authData
instead
- phone string? - Phone number
- receiverLanguage string? - IETF language tag
- title string? - Deprecated since v4.18.0 Job title
- userName string? - Since v4.13.0 Username
dracoon.public: GeneralSettings![](/images/permalink.svg)
General settings
Fields
- authTokenRestrictions AuthTokenRestrictions? - Auth token restrictions
- cryptoEnabled boolean? - Activation status of client-side encryption. Can only be enabled once; disabling is not possible.
- emailNotificationButtonEnabled boolean? - Enable email notification button
- eulaEnabled boolean? - Each user has to confirm the EULA at first login.
- hideLoginInputFields boolean? - Since v4.13.0 Defines if login fields should be hidden
- mediaServerEnabled boolean? - Deprecated since v4.12.0 Determines if the media server is enabled
- s3TagsEnabled boolean? - Since v4.9.0 Defines if S3 tags are enabled
- sharePasswordSmsEnabled boolean? - Allow sending of share passwords via SMS
- useS3Storage boolean? - Defines if S3 is used as storage backend
- weakPasswordEnabled boolean? - Deprecated since v4.14.0
Allow weak password
- A weak password has to fulfill the following criteria:
- is at least 8 characters long
- contains letters and numbers
- A strong password has to fulfill the following criteria in addition:
- contains at least one special character
- contains upper and lower case characters
GET /system/config/policies/passwords
API to get configured password policies.
dracoon.public: GeneralSettingsInfo![](/images/permalink.svg)
General settings
Fields
- cryptoEnabled boolean? - Activation status of client-side encryption. Can only be enabled once; disabling is not possible.
- emailNotificationButtonEnabled boolean? - Enable email notification button
- eulaEnabled boolean? - Each user has to confirm the EULA at first login.
- homeRoomParentId int? - Since v4.10.0 Homeroom Parent ID
- homeRoomsActive boolean? - Since v4.10.0 Homerooms active
- mediaServerEnabled boolean? - Deprecated since v4.12.0 Determines if the media server is enabled
- s3TagsEnabled boolean? - Since v4.9.0 Defines if S3 tags are enabled
- sharePasswordSmsEnabled boolean? - Allow sending of share passwords via SMS
- useS3Storage boolean? - Defines if S3 is used as storage backend
- weakPasswordEnabled boolean? - Allow weak password
- A weak password has to fulfill the following criteria:
- is at least 8 characters long
- contains letters and numbers
- A strong password has to fulfill the following criteria in addition:
- contains at least one special character
- contains upper and lower case characters
dracoon.public: GeneratePresignedUrlsRequest![](/images/permalink.svg)
Request model for generating presigned URLs
Fields
- firstPartNumber int - First part number of a range of requested presigned URLs (for S3 it is:
1
)
- lastPartNumber int - Last part number of a range of requested presigned URLs
- size int -
Content-Length
header size for each presigned URL (in bytes) MUST be >= 5 MB except the last part.
dracoon.public: Group![](/images/permalink.svg)
Group information
Fields
- cntUsers int - Amount of users
- createdAt string - Creation date
- createdBy UserInfo - User information
- expireAt string? - Expiration date
- groupRoles RoleList? - List of roles
- id int - Unique identifier for the group
- name string - Group name
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: GroupIds![](/images/permalink.svg)
List of group IDs
Fields
- ids int[] - List of group IDs
dracoon.public: GroupInfo![](/images/permalink.svg)
Group information
Fields
- id int - Unique identifier for the group
- name string - Group name
dracoon.public: GroupList![](/images/permalink.svg)
List of groups
Fields
- items Group[] - List of groups
- range Range - Range information
dracoon.public: GroupUser![](/images/permalink.svg)
User information
Fields
- displayName string - Deprecated since v4.11.0
Display name
use information from
UserInfo
instead to combine a display name
- email string - Deprecated since v4.11.0
Email
use
email
fromUserInfo
instead
- id int - Deprecated since v4.11.0
Unique identifier for the user
use
id
fromUserInfo
instead
- isMember boolean - Determines whether user is a member of the group or not
- login string - Deprecated since v4.11.0 User login name
- userInfo UserInfo - User information
dracoon.public: GroupUserList![](/images/permalink.svg)
List of users
Fields
- items GroupUser[] - List of group-user mappings
- range Range - Range information
dracoon.public: InfrastructureProperties![](/images/permalink.svg)
Infrastructure properties
Fields
- isDracoonCloud boolean? - Since v4.21.0 Determines if the DRACOON Core is deployed in the cloud environment
- mediaServerConfigEnabled boolean? - Determines if the media server is enabled
- s3DefaultRegion string? - Suggested S3 Region
- s3EnforceDirectUpload boolean? - Since v4.15.0 Enforce direct upload to S3
- smsConfigEnabled boolean? - Allow sending of share passwords via SMS
- tenantUuid string? - Since v4.21.0 Current tenant UUID
dracoon.public: KeyValueEntry![](/images/permalink.svg)
Key-value pair
Fields
- 'key string - Entry key
- value string - Entry value
dracoon.public: LastAdminGroupRoom![](/images/permalink.svg)
Room information
Fields
- id int - Room ID
- name string - Room name
- parentId int? - Parent room ID
- parentPath string - Parent node path
/
if node is a root node (room)
dracoon.public: LastAdminGroupRoomList![](/images/permalink.svg)
List of (last admin group) rooms
Fields
- items LastAdminGroupRoom[] - List of last admin rooms
dracoon.public: LastAdminUserRoom![](/images/permalink.svg)
Room information
Fields
- id int - Room ID
- lastAdminInGroup boolean - Determines whether user is last admin of a room due to being the last member of last admin group
- lastAdminInGroupId int? - ID of the last admin group where the user is the only remaining member
(returned only if
lastAdminInGroup
istrue
)
- name string - Room name
- parentId int? - Parent room ID
- parentPath string - Parent node path
/
if node is a root node (room)
dracoon.public: LastAdminUserRoomList![](/images/permalink.svg)
List of (last admin user) rooms
Fields
- items LastAdminUserRoom[] - List of last admin rooms
dracoon.public: LogEvent![](/images/permalink.svg)
Log event information
Fields
- attribute1 string? - Attribute 1
- attribute2 string? - Attribute 2
- attribute3 string? - Attribute 3
- authParentSource string? - Auth parent source ID
- authParentTarget string? - Auth parent target ID
- customerId int? - Unique identifier for the customer
- id int - Event ID
- message string - Event description
- objectId1 int? - Object ID 1
- objectId2 int? - Object ID 2
- objectName1 string? - Object name 1
- objectName2 string? - Object name 2
- objectType1 int? - Object type 1
- objectType2 int? - Object type 2
- operationId int? - Operation type ID
- operationName string? - Operation name
- status int? - Operation status:
-
0
- Success -
2
- Error
-
- time string - Event timestamp
- userClient string? - Client
- userId int - Unique identifier for the user
- userIp string? - User IP
- userName string? - Username
dracoon.public: LogEventList![](/images/permalink.svg)
List of log events
Fields
- items LogEvent[] - List of log events
- range Range - Range information
dracoon.public: LoginPasswordPolicies![](/images/permalink.svg)
Login password policies
Fields
- characterRules CharacterRules - Password character rules
- minLength int - Minimum number of characters a password must contain
- numberOfArchivedPasswords int - Number of passwords to archive
(must be between
0
and10
;0
means that password history is disabled)
- passwordExpiration PasswordExpiration - Password expiration information
- rejectDictionaryWords boolean - Determines whether a password must NOT contain word(s) from a dictionary
- rejectKeyboardPatterns boolean - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean - Determines whether a password must NOT contain user info (first name, last name, email, user name)
- updatedAt string - Modification date
- updatedBy UserInfo - User information
- userLockout UserLockout - User lockout information
dracoon.public: LoginRequest![](/images/permalink.svg)
Request model for performing an authentication
Fields
- authType string? - Authentication methods
- language string? - Deprecated since v4.7.0 Language ID or ISO 639-1 code
- login string? - Deprecated since v4.7.0 User login name
- password string - Password
- state string? - For RADIUS Access-Challenge
If a
replyState
is returned, it must be included asstate
in the following request.
- token string? - RADIUS Token
- userName string? - Since v4.13.0 Username
dracoon.public: LoginResponse![](/images/permalink.svg)
Authentication token
Fields
- token string - Authentication token
dracoon.public: LogOperation![](/images/permalink.svg)
Log operation
Fields
- id int - Operation type ID
- isDeprecated boolean - Determines whether log operation is deprecated or not
- name string - Operation name
dracoon.public: LogOperationList![](/images/permalink.svg)
List of log operations
Fields
- operationList LogOperation[] - List of all log operations
dracoon.public: MissingKeysResponse![](/images/permalink.svg)
Missing keys information
Fields
- files FileFileKeys[]? - List of file keys
- items UserIdFileIdItem[]? - List of user ID and file ID mappings
- range Range? - Range information
- users UserUserPublicKey[]? - List of user public keys
dracoon.public: MoveNode![](/images/permalink.svg)
Moved node information
Fields
- id int - Source node ID
- name string? - New node name
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: MoveNodesRequest![](/images/permalink.svg)
Request model for moving nodes
Fields
- items MoveNode[]? - List of nodes to be moved
- keepShareLinks boolean? - Preserve Download Share Links and point them to the new node.
- nodeIds int[]? - Deprecated since v4.5.0
Node IDs
Please use
items
instead.
- resolutionStrategy string? - Node conflict resolution strategy:
-
autorename
-
overwrite
-
fail
-
dracoon.public: NewCustomerRequest![](/images/permalink.svg)
Request model for creating a customer
Fields
- activationCode string? - Deprecated since v4.8.0
Customer activation code string:
-
valid only for types
free
anddemo
-
for
pay
customers it is empty
-
valid only for types
- companyName string? - Company name
- customerAttributes CustomerAttributes? - List of customer attributes
- customerContractType string - Customer type
- firstAdminUser FirstAdminUser - First administrator user
- isLocked boolean(default false) - Customer is locked:
-
false
- unlocked -
true
- locked
-
- lockStatus boolean(default false) - Deprecated since v4.7.0
Customer lock status:
-
false
- unlocked -
true
- locked
isLocked
instead. All users of this customer will be blocked and can not login anymore. -
- providerCustomerId string? - Provider customer ID
- quotaMax int - Maximal disc space which can be allocated by customer in bytes. -1 for unlimited
- trialDays int? - Number of days left for trial period (relevant only for type
demo
) (not used)
- userMax int - Maximal number of users
- webhooksMax int? - Since v4.19.0 Maximal number of webhooks
dracoon.public: NewCustomerResponse![](/images/permalink.svg)
Customer information
Fields
- activationCode string? - Deprecated since v4.8.0
Customer activation code string:
-
valid only for types
free
anddemo
-
for
pay
customers it is empty
-
valid only for types
- companyName string - Company name
- createdAt string? - Creation date
- customerAttributes CustomerAttributes? - List of customer attributes
- customerContractType string - Customer type
- customerUuid string - Since v4.21.0 Customer UUID
- firstAdminUser FirstAdminUser - First administrator user
- id int? - Unique identifier for the customer
- isLocked boolean(default false) - Customer is locked:
-
false
- unlocked -
true
- locked
-
- lockStatus boolean - Deprecated since v4.7.0
Customer lock status:
-
false
- unlocked -
true
- locked
isLocked
instead. All users of this customer will be blocked and can not login anymore. -
- providerCustomerId string? - Provider customer ID
- quotaMax int - Maximal disc space which can be allocated by customer in bytes. -1 for unlimited
- trialDays int? - Number of days left for trial period (relevant only for type
demo
) (not used)
- userMax int - Maximal number of users
- webhooksMax int? - Since v4.19.0 Maximal number of webhooks
dracoon.public: Node![](/images/permalink.svg)
Node information (Node can be a room, folder or file)
Fields
- authParentId int? - Since v4.15.0 Auth parent room ID
- branchVersion int? - Version of last change in this node or a node further down the tree.
- children Node[]? - Deprecated since v4.10.0 Child nodes list (if requested) (for rooms / folders only)
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- cntAdmins int? - Deprecated since v4.2.0 Number of admins (for rooms only)
- cntChildren int? - Deprecated since v4.11.0 Number of direct children (no recursion; for rooms / folders only)
- cntComments int? - Returns the number of comments of this node.
- cntDeletedVersions int? - Number of deleted versions of this file / folder (for rooms / folders only)
- cntDownloadShares int? - Returns the number of Download Shares of this node.
- cntFiles int? - Since v4.11.0 Amount of direct child files where this node is the parent node (no recursion; for rooms / folders only)
- cntFolders int? - Since v4.11.0 Amount of direct child folders where this node is the parent node (no recursion; for rooms / folders only)
- cntRooms int? - Since v4.11.0 Amount of direct child rooms where this node is the parent node (no recursion; for rooms only)
- cntUploadShares int? - Returns the number of Upload Shares of this node.
- cntUsers int? - Deprecated since v4.2.0 Number of users (for rooms only)
- createdAt string? - Creation date
- createdBy UserInfo? - User information
- encryptionInfo EncryptionInfo? - Encryption states
- expireAt string? - Expiration date
- fileType string? - File type / extension (for files only)
- hasActivitiesLog boolean(default true) - Is activities log active (for rooms only)
- hasRecycleBin boolean? - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- hash string? - MD5 hash of file
- id int - Node ID
- inheritPermissions boolean? - Inherit permissions from parent room
(default:
false
ifparentId
is0
; otherwise:true
)
- isBrowsable boolean? - Since v4.11.0 Determines whether node is browsable by client (for rooms only)
- isEncrypted boolean? - Encryption state
- isFavorite boolean? - Node is marked as favorite (for rooms / folders only)
- mediaToken string? - Media server media token
- mediaType string? - File media type (for files only)
- name string - Name
- notes string? - User notes
- parentId int? - Parent node ID (room or folder)
- parentPath string? - Parent node path
/
if node is a root node (room)
- permissions NodePermissions? - Node permissions
- quota int? - Quota in byte
- recycleBinRetentionPeriod int? - Retention period for deleted nodes in days
- size int? - Node size in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system
- 'type string - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: NodeList![](/images/permalink.svg)
List of nodes
Fields
- items Node[] - List of nodes
- range Range - Range information
dracoon.public: NodeParent![](/images/permalink.svg)
Parent node
Fields
- id int - Node ID
- name string - Node name
- parentId int? - Parent node ID (room or folder)
- 'type string - Node type
dracoon.public: NodeParentList![](/images/permalink.svg)
List of parent nodes
Fields
- items NodeParent[]? - List of node parents
dracoon.public: NodePermissions![](/images/permalink.svg)
Node permissions
Fields
- change boolean - User / Group may update metadata of nodes: rename files and folders, change classification, etc.
- create boolean - User / Group may upload files, create folders and copy / move files to this room, overwriting is not possible.
- delete boolean - User / Group may overwrite and remove files / folders, move files from this room.
- deleteRecycleBin boolean - User / Group may permanently remove files / folders from the recycle bin.
- manage boolean - User / Group may grant all of the above permissions to other users and groups independently, may update room metadata and create / update / delete subordinary rooms, has all permissions.
- manageDownloadShare boolean - User / Group may create Download Shares for files and containers view all previously created Download Shares in this room.
- manageUploadShare boolean - User / Group may create Upload Shares for containers, view all previously created Upload Shares in this room.
- read boolean - User / Group may see all rooms, files and folders in the room and download everything, copy files from this room.
- readRecycleBin boolean - User / Group may look up files / folders in the recycle bin.
- restoreRecycleBin boolean - User / Group may restore files / folders from recycle bin - room permissions required.
dracoon.public: NotificationChannel![](/images/permalink.svg)
Notification channel information
Fields
- frequency int - Channel frequency (aggregation window size in minutes)
- id int - Channel ID
- isEnabled boolean - Determines whether channel is enabled
- name string - Name
- 'type string - Channel type (only
EMAIL
available at the moment)
dracoon.public: NotificationChannelActivationRequest![](/images/permalink.svg)
Request model for switching notification channel status
Fields
- channelId int - Channel ID
- isEnabled boolean - Determines whether channel is enabled
dracoon.public: NotificationChannelList![](/images/permalink.svg)
List of notification channels
Fields
- items NotificationChannel[] - List of notification channels
dracoon.public: NotificationConfig![](/images/permalink.svg)
Notification configuration information
Fields
- channelIds int[] - List of notification channel IDs
- eventTypeName string - Event type name
- id int - Notification configuration ID
- scopeId int - Scope ID
dracoon.public: NotificationConfigChangeRequest![](/images/permalink.svg)
Request model for updating notification configuration
Fields
- channelIds int[] - List of notification channel IDs. Leave empty to disable notifications.
dracoon.public: NotificationConfigList![](/images/permalink.svg)
List of notification configurations
Fields
- items NotificationConfig[] - List of notification configurations
dracoon.public: NotificationScope![](/images/permalink.svg)
Notification scope information
Fields
- id int - Scope ID
- name string - Name
dracoon.public: NotificationScopeList![](/images/permalink.svg)
List of notification scopes
Fields
- items NotificationScope[] - List of notification scopes
dracoon.public: OAuth2RefreshTokenGrantConfig![](/images/permalink.svg)
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "/oauth/token") - Refresh URL
dracoon.public: OAuthApproval![](/images/permalink.svg)
OAuth client approval information
Fields
- clientId string - ID of the OAuth client
- clientName string - Name, which is shown at the client configuration and authorization.
- expiresAt string? - Expiration date of the approval
dracoon.public: OAuthAuthorization![](/images/permalink.svg)
OAuth authorization
Fields
- clientId string - ID of the OAuth client
- clientName string - Name, which is shown at the client configuration and authorization.
- createdAt string? - Since v4.13.0 Creation date of the authorization
- expiresAt string? - Expiration date of the authorization
- id int? - Since v4.12.0 ID of the OAuth authorization
- isCurrentAuthorization boolean? - Since v4.25.0 Determines whether authorization matches the one from Authorization Header
- isStandard boolean? - Since v4.12.0 Determines whether client is a standard client.
- usedAt string? - Since v4.13.0 Usage date of the authorization (Time of last usage.)
- userAgentCategory string - Since v4.12.0 User agent category.
- userAgentInfo string? - Since v4.12.0 User agent info.
- userAgentOs string? - Since v4.12.0 User agent OS.
- userAgentType string? - Since v4.12.0 User agent type.
dracoon.public: OAuthClient![](/images/permalink.svg)
OAuth client information
Fields
- accessTokenValidity int? - Validity of the access token in seconds.
- approvalValidity int? - Since v4.22.0 Validity of the approval interval in seconds.
- clientId string - ID of the OAuth client
- clientName string? - Name, which is shown at the client configuration and authorization.
- clientSecret string? - Secret, which client uses at authentication.
- clientType string? - Determines whether client is a confidential or public client.
- isEnabled boolean? - Determines whether client is enabled.
- isExternal boolean? - Determines whether client is an external client.
- isStandard boolean? - Determines whether client is a standard client.
- redirectUris string[]? - URIs, to which a user is redirected after authorization.
- refreshTokenValidity int? - Validity of the refresh token in seconds.
dracoon.public: ObjectExpiration![](/images/permalink.svg)
Expiration information
Fields
- enableExpiration boolean - enabled / disabled
- expireAt string? - Expiration date
dracoon.public: OpenIdAuthInfo![](/images/permalink.svg)
List of OpenID Connect providers
Fields
- items OpenIdProvider[] - List of available OpenID Connect identity providers
dracoon.public: OpenIdAuthResources![](/images/permalink.svg)
List of OpenID Connect providers
Fields
- openIdProviders OpenIdProvider[] - List of available OpenID Connect identity providers
dracoon.public: OpenIdIdpConfig![](/images/permalink.svg)
OpenID Connect IDP configuration
Fields
- authorizationEndPointUrl string? - URL of the authorization endpoint
- clientId string? - ID of the OpenID client
- clientSecret string? - Secret, which client uses at authentication.
- fallbackMappingClaim string? - Name of the claim which is used for the user mapping fallback.
- flow string? - Since v4.11.0 Flow, which is used at authentication
- id int - ID
- issuer string? - Issuer identifier of the IDP The value is a case sensitive URL.
- jwksEndPointUrl string? - URL of the JWKS endpoint
- mappingClaim string? - Name of the claim which is used for the user mapping.
- name string? - Name of the IDP
- redirectUris string[]? - URIs, to which a user is redirected after authorization.
- scopes string[]? - List of requested scopes
Usually
openid
and the names of the requested claims.
- tokenEndPointUrl string? - URL of the token endpoint
- userImportEnabled boolean(default false) - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
- userImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- userInfoEndPointUrl string? - URL of the user info endpoint
- userInfoSource string? - Since v4.23.0 Source, which is used to get user information at the import or update of a user.
- userManagementUrl string? - URL of the user management UI. Use empty string to remove.
- userUpdateEnabled boolean(default false) - Determines if the DRACOON account is updated with data from AD / IDP.
For OpenID Connect, the scopes
email
andprofile
are needed.
dracoon.public: OpenIdProvider![](/images/permalink.svg)
OpenID Connect provider information
Fields
- id int - ID
- isGlobalAvailable boolean - Is available for all customers
- issuer string - Issuer identifier of the IDP The value is a case sensitive URL.
- mappingClaim string - Name of the claim which is used for the user mapping.
- name string - Name of the IDP
- userManagementUrl string? - URL of the user management UI. Use empty string to remove.
dracoon.public: PasswordExpiration![](/images/permalink.svg)
Password expiration information
Fields
- enabled boolean - Determines whether password expiration is enabled
- maxPasswordAge int? - Maximum allowed password age (in days)
dracoon.public: PasswordPoliciesConfig![](/images/permalink.svg)
Set of password policies
Fields
- encryptionPasswordPolicies EncryptionPasswordPolicies? - Encryption password policies
- loginPasswordPolicies LoginPasswordPolicies? - Login password policies
- sharesPasswordPolicies SharesPasswordPolicies? - Shares password policies
dracoon.public: PasswordPolicyViolationResponse![](/images/permalink.svg)
List of violated password policies
Fields
- code int - HTTP status code
- debugInfo string? - Debug information
- errorCode int? - Internal error code
- message string - HTTP status code description
- violatedPasswordPolicies ViolatedPasswordPolicy[]? - List of violated password policies
dracoon.public: PendingAssignment![](/images/permalink.svg)
Pending assignment information
Fields
- groupId int - Unique identifier for the group
- roomId int - Room ID
- roomName string - Room name
- state string - Acceptance state:
-
ACCEPTED
-
WAITING
-
DENIED
-
- userId int - Unique identifier for the user
dracoon.public: PendingAssignmentData![](/images/permalink.svg)
Pending assignment information
Fields
- groupId int? - Deprecated since v4.2.0 Unique identifier for the group
- groupInfo GroupInfo - Group information
- pendingGroupData PendingGroupData - Pending group information
- pendingUserData PendingUserData - Pending user information
- roomId int - Room ID
- roomName string - Room name
- state string - Acceptance state:
-
ACCEPTED
-
WAITING
-
DENIED
-
- userId int? - Deprecated since v4.2.0 Unique identifier for the user
- userInfo UserInfo - User information
dracoon.public: PendingAssignmentList![](/images/permalink.svg)
List of pending assignments
Fields
- items PendingAssignmentData[] - List of pending assignment information
- range Range? - Range information
dracoon.public: PendingAssignmentsRequest![](/images/permalink.svg)
Request model for handling pending assignments
Fields
- items PendingAssignment[] - List of pending assignments
dracoon.public: PendingGroupData![](/images/permalink.svg)
Pending group information
Deprecated
Fields
- id int - Unique identifier for the group
use
id
fromGroupInfo
instead
- name string - Group name
use
name
fromGroupInfo
instead
dracoon.public: PendingUserData![](/images/permalink.svg)
Pending user information
Deprecated
Fields
- displayName string - Display name
use information from
UserInfo
instead to combine a display name
- email string - Email
use
email
fromUserInfo
instead
- id int - Unique identifier for the user
- login string - User login name
dracoon.public: PresignedUrl![](/images/permalink.svg)
Presigned URL information
Fields
- partNumber int - Corresponding part number
- url string - S3 presigned URL
dracoon.public: PresignedUrlList![](/images/permalink.svg)
List of generated presigned URLs
Fields
- urls PresignedUrl[] - List of S3 presigned URLs
dracoon.public: PrivateKeyContainer![](/images/permalink.svg)
Private key container
Fields
- createdAt string? - Since v4.24.0 Creation date
- createdBy int? - Since v4.24.0 Created by user
- expireAt string? - Expiration date
- privateKey string - Private key
- 'version string - Version
dracoon.public: ProfileAttributes![](/images/permalink.svg)
User profile attributes
Fields
- items KeyValueEntry[] - List of key-value pairs
- range Range - Range information
dracoon.public: ProfileAttributesRequest![](/images/permalink.svg)
Request model for setting user profile attributes
Fields
- items KeyValueEntry[] - List of key-value pairs
dracoon.public: PublicDownloadShare![](/images/permalink.svg)
Download Share information
Fields
- createdAt string - Creation date
- creatorName string - Creator name
- creatorUsername string? - Creator username
- expireAt string? - Expiration date
- fileKey FileKey? - File key information
- fileName string - File name
- hasDownloadLimit boolean - Since v4.11.0 Determines whether Download Share has a limit for amount of downloads
- isEncrypted boolean? - Encryption state
- isProtected boolean - Is share protected by password
- limitReached boolean - Downloads limit reached
- mediaType string - Since v4.11.0
-
application/zip
(for folders and rooms) - actual file media type (for files only)
-
- name string? - Share display name (alias name)
- notes string? - User notes
- privateKeyContainer PrivateKeyContainer? - Private key container
- size int - File size or container size not compressed (in bytes)
dracoon.public: PublicDownloadTokenGenerateRequest![](/images/permalink.svg)
Request model for generating download URL
Fields
- password string? - Password (only for password-protected shares)
dracoon.public: PublicDownloadTokenGenerateResponse![](/images/permalink.svg)
Download URL
Fields
- downloadUrl string? - Download URL
- token string - Deprecated since v4.3.0 Download token
dracoon.public: PublicKeyContainer![](/images/permalink.svg)
Public key container
Fields
- createdAt string? - Since v4.24.0 Creation date
- createdBy int? - Since v4.24.0 Created by user
- expireAt string? - Expiration date
- publicKey string - Public key
- 'version string - Version
dracoon.public: PublicUploadedFileData![](/images/permalink.svg)
File information
Fields
- createdAt string - Creation date
- hash string? - Hash value of transferred file
- name string - Name
- size int - File size in byte
dracoon.public: PublicUploadShare![](/images/permalink.svg)
Upload Share information
Fields
- createdAt string - Creation date
- creatorName string - Since v4.11.0 Creator name
- creatorUsername string? - Since v4.11.0 Creator username
- expireAt string? - Expiration date
- isEncrypted boolean? - Encryption state
- isProtected boolean - Is share protected by password
- maxSize decimal? - Deprecated since v4.2.0 Maximal total size of uploaded files (in bytes)
- maxSlots int - Deprecated since v4.2.0 Maximal amount of files to upload
- name string? - Share display name (alias name)
- notes string? - User notes
- remainingSize int? - Remaining size
- remainingSlots int? - Remaining slots
- showUploadedFiles boolean? - Allow display of already uploaded files
- uploadedFiles PublicUploadedFileData[]? - List of (public) uploaded files
- userUserPublicKeyList UserUserPublicKeyList? - List of user public keys
dracoon.public: RadiusChallengeResponse![](/images/permalink.svg)
RADIUS challenge reply
Fields
- code int - HTTP status code
- debugInfo string? - Debug information
- errorCode int? - Internal error code
- message string - HTTP status code description
- replyMessage string - RADIUS Reply-Message Instruction how to handle the situation.
- replyState string - For RADIUS Access-Challenge
If a
replyState
is returned, it must be included asstate
in the following request.
dracoon.public: RadiusConfig![](/images/permalink.svg)
RADIUS configuration
Fields
- failoverServer FailoverServer? - Failover server information
- ipAddress string - RADIUS Server IP Address
- otpPinFirst boolean - Sequence order of concatenated PIN and one-time token
- port int - RADIUS Server Port
- sharedSecret string - Shared Secret to access the RADIUS server
dracoon.public: RadiusConfigCreateRequest![](/images/permalink.svg)
Request model for creating a RADIUS configuration
Fields
- failoverServer FailoverServer? - Failover server information
- ipAddress string - RADIUS Server IP Address
- otpPinFirst boolean(default true) - Sequence order of concatenated PIN and one-time token
- port int - RADIUS Server Port
- sharedSecret string - Shared Secret to access the RADIUS server
dracoon.public: RadiusConfigUpdateRequest![](/images/permalink.svg)
Request model for updating a RADIUS configuration
Fields
- failoverServer FailoverServer? - Failover server information
- ipAddress string? - RADIUS Server IP Address
- otpPinFirst boolean? - Sequence order of concatenated PIN and one-time token
- port int? - RADIUS Server Port
- sharedSecret string? - Shared Secret to access the RADIUS server
dracoon.public: Range![](/images/permalink.svg)
Range information
Fields
- 'limit int - Range limit. Maximum 500.
- offset int - Range offset
- total int - Total items available
dracoon.public: RecoverUserNameRequest![](/images/permalink.svg)
Recover usernames for email
Fields
- creatorLanguage string? - IETF language tag
- email string - Email
dracoon.public: ResetPasswordRequest![](/images/permalink.svg)
Request model for reseting user's login password
Fields
- creatorLanguage string? - IETF language tag
- language string? - Deprecated since v4.7.0 Language ID or ISO 639-1 code
- login string? - Deprecated since v4.13.0 User login name
- userName string? - Since v4.13.0 Username
dracoon.public: ResetPasswordTokenValidateResponse![](/images/permalink.svg)
Password reset information
Fields
- allowSystemGlobalWeakPassword boolean? - Deprecated since v4.14.0
Allow weak password
Please use
loginPasswordPolicies
instead
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0 Gender
- lastName string - User last name
- loginPasswordPolicies LoginPasswordPolicies? - Login password policies
- title string? - Deprecated since v4.18.0 Job title
dracoon.public: ResetPasswordWithTokenRequest![](/images/permalink.svg)
New password
Fields
- password string - New password
dracoon.public: RestoreDeletedNodesRequest![](/images/permalink.svg)
Request model for restoring deleted nodes
Fields
- deletedNodeIds int[] - List of deleted node IDs
- keepShareLinks boolean(default false) - Preserve Download Share Links and point them to the new node.
- parentId int? - Node parent ID (default: previous parent ID)
- resolutionStrategy string(default "autorename") - Node conflict resolution strategy:
-
autorename
-
overwrite
-
fail
-
dracoon.public: Right![](/images/permalink.svg)
Right information
Fields
- description string - Right description
- id int - Unique identifier for the right
- name string - Right (unique) name
dracoon.public: Role![](/images/permalink.svg)
Role information
Fields
- description string - Role description
- id int - Unique identifier for the role
- items Right[]? - List of reachable right over role
- name string - Role (unique) name
dracoon.public: RoleGroup![](/images/permalink.svg)
Group information
Fields
- id int - Unique identifier for the group
- isMember boolean - Is group member of the role
- name string - Group name
dracoon.public: RoleGroupList![](/images/permalink.svg)
List of groups with assigned role
Fields
- items RoleGroup[] - List of role-group mappings
- range Range - Range information
dracoon.public: RoleList![](/images/permalink.svg)
List of roles
Fields
- items Role[] - List of roles
dracoon.public: RoleUser![](/images/permalink.svg)
User information
Fields
- displayName string - Deprecated since v4.11.0
Display name
use information from
UserInfo
instead to combine a display name
- id int - Deprecated since v4.11.0
Unique identifier for the user
use
id
fromUserInfo
instead
- isMember boolean - Is user member of the role
- userInfo UserInfo - User information
dracoon.public: RoleUserList![](/images/permalink.svg)
List of users with assigned role
Fields
- items RoleUser[] - List of role-user mappings
- range Range - Range information
dracoon.public: RoomData![](/images/permalink.svg)
Room information
Fields
- children RoomData[]? - Deprecated since v4.10.0 List of rooms, where this room is a parent (if exist)
- cntAdmins int? - Deprecated since v4.2.0 Number of admins (for rooms only)
- cntDownloadShares int? - Returns the number of Download Shares of this node.
- cntUploadShares int? - Returns the number of Upload Shares of this node.
- cntUsers int? - Deprecated since v4.2.0 Number of users (for rooms only)
- createdAt string? - Expiration date
- createdBy UserInfo? - User information
- hasRecycleBin boolean - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- id int - Room ID
- isEncrypted boolean - Encryption state
- isFavorite boolean? - Node is marked as favorite (for rooms / folders only)
- isGranted boolean - Is user granted room permissions
- name string - Name
- parentId int? - Parent node ID (room or folder)
- permissions NodePermissions? - Node permissions
- quota int? - Quota in byte
- recycleBinRetentionPeriod int - Retention period for deleted nodes in days
- size int? - Room size
- 'type string? - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: RoomGroup![](/images/permalink.svg)
Group information
Fields
- id int - Unique identifier for the group
- isGranted boolean - Is user granted room permissions
- name string - Group name
- newGroupMemberAcceptance string(default "autoallow") - Behaviour when new users are added to the group:
-
autoallow
-
pending
adminGroupIds
has items. -
- permissions NodePermissions? - Node permissions
dracoon.public: RoomGroupList![](/images/permalink.svg)
List of groups
Fields
- items RoomGroup[] - List of room-group mappings
- range Range - Range information
dracoon.public: RoomGroupsAddBatchRequest![](/images/permalink.svg)
Request model for granting group(s) to the room
Fields
- items RoomGroupsAddBatchRequestItem[] - List of room-group mappings
dracoon.public: RoomGroupsAddBatchRequestItem![](/images/permalink.svg)
Request item model for granting group to the room
Fields
- id int - Unique identifier for the group
- newGroupMemberAcceptance string(default "autoallow") - Behaviour when new users are added to the group:
-
autoallow
-
pending
adminGroupIds
has items. -
- permissions NodePermissions - Node permissions
dracoon.public: RoomGroupsDeleteBatchRequest![](/images/permalink.svg)
Request model for revoking group(s) from the room
Fields
- ids int[] - List of group IDs
dracoon.public: RoomTreeDataList![](/images/permalink.svg)
List of rooms
Fields
- items RoomData[] - List of room data information
- range Range - Range information
dracoon.public: RoomUser![](/images/permalink.svg)
User information
Fields
- displayName string - Deprecated since v4.11.0
Display name
use information from
UserInfo
instead to combine a display name
- email string - Deprecated since v4.11.0
Email
use
email
fromUserInfo
instead
- id int - Deprecated since v4.11.0
Unique identifier for the user
use
id
fromUserInfo
instead
- isGranted boolean - Is user granted room permissions
- login string - Deprecated since v4.11.0 User login name
- permissions NodePermissions? - Node permissions
- publicKeyContainer PublicKeyContainer? - Public key container
- userInfo UserInfo - User information
dracoon.public: RoomUserList![](/images/permalink.svg)
List of users
Fields
- items RoomUser[] - List of room-user mappings
- range Range - Range information
dracoon.public: RoomUsersAddBatchRequest![](/images/permalink.svg)
Request model for granting user(s) to the room
Fields
- items RoomUsersAddBatchRequestItem[] - List of room-user mappings
dracoon.public: RoomUsersAddBatchRequestItem![](/images/permalink.svg)
Request item model for granting user to the room
Fields
- id int - Unique identifier for the user
- permissions NodePermissions - Node permissions
dracoon.public: RoomUsersDeleteBatchRequest![](/images/permalink.svg)
Request model for revoking user(s) from the room
Fields
- ids int[] - List of user IDs
dracoon.public: RoomWebhook![](/images/permalink.svg)
Webhook information
Fields
- isAssigned boolean - Determines whether webhook is assigned to the room.
- webhook Webhook - Webhook information
dracoon.public: RoomWebhookAssignment![](/images/permalink.svg)
Request model for handling webhook assignments
Fields
- isAssigned boolean - Determines whether webhook is assigned to the room.
- webhookId int - Webhook ID
dracoon.public: RoomWebhookList![](/images/permalink.svg)
List of webhooks
Fields
- items RoomWebhook[] - List of webhooks
- range Range - Range information
dracoon.public: S3Config![](/images/permalink.svg)
S3 configuration
Fields
- accessKeyDefined boolean - Determines whether Access Key ID is defined
- bucketName string? - Deprecated since v4.24.0
S3 bucket name
use
bucketUrl
instead
- bucketUrl string - S3 object storage bucket URL
- endpointUrl string? - Deprecated since v4.24.0
S3 object storage endpoint URL
use
bucketUrl
instead
- region string? - S3 region
- secretKeyDefined boolean - Determines whether Access Secret Key is defined
dracoon.public: S3ConfigCreateRequest![](/images/permalink.svg)
Request model for creating a S3 configuration
Fields
- accessKey string - Access Key ID
- bucketName string? - Deprecated since v4.24.0
S3 bucket name
use
bucketUrl
instead
- bucketUrl string? - S3 object storage bucket URL
- endpointUrl string? - Deprecated since v4.24.0
S3 object storage endpoint URL
use
bucketUrl
instead
- region string? - S3 region
- secretKey string - Secret Access Key
dracoon.public: S3ConfigUpdateRequest![](/images/permalink.svg)
Request model for updating a S3 configuration
Fields
- accessKey string? - Access Key ID
- bucketName string? - Deprecated since v4.24.0
S3 bucket name
use
bucketUrl
instead
- bucketUrl string? - S3 object storage bucket URL
- endpointUrl string? - Deprecated since v4.24.0
S3 object storage endpoint URL
use
bucketUrl
instead
- region string? - S3 region
- secretKey string? - Secret Access Key
dracoon.public: S3FileUploadPart![](/images/permalink.svg)
S3 file upload part information
Fields
- partEtag string - Corresponding part ETag
- partNumber int - Corresponding part number
dracoon.public: S3FileUploadStatus![](/images/permalink.svg)
S3 file upload status information
Fields
- errorDetails ErrorResponse? - Error information
- node Node? - Node information (Node can be a room, folder or file)
- status string - S3 file upload status:
-
transfer
- upload in progress -
finishing
- completing file upload -
done
- file upload successully done -
error
- an error occurred while file upload
-
dracoon.public: S3ShareUploadStatus![](/images/permalink.svg)
S3 file upload status information
Fields
- errorDetails ErrorResponse? - Error information
- fileName string - File name
- size int? - File size in byte
- status string - S3 file upload status:
-
transfer
- upload in progress -
finishing
- completing file upload -
done
- file upload successully done -
error
- an error occurred while file upload
-
dracoon.public: S3Tag![](/images/permalink.svg)
S3 tag information
Fields
- id int? - S3 tag ID
- isMandatory boolean? - Determines whether S3 is mandatory or not
- 'key string? - S3 tag key
- value string? - S3 tag value
dracoon.public: S3TagCreateRequest![](/images/permalink.svg)
Request model for creating a S3 tag
Fields
- isMandatory boolean(default false) - Determines whether S3 is mandatory or not
- 'key string - S3 tag key
- value string - S3 tag value
dracoon.public: S3TagIds![](/images/permalink.svg)
List of S3 tag IDs
Fields
- ids int[] - List of S3 tag IDs
dracoon.public: S3TagList![](/images/permalink.svg)
List of S3 tags
Fields
- items S3Tag[]? - List of configured S3 tags
dracoon.public: SdsServerTime![](/images/permalink.svg)
DRACOON server time
Fields
- time string? - DRACOON server time
dracoon.public: SharesPasswordPolicies![](/images/permalink.svg)
Shares password policies
Fields
- characterRules CharacterRules? - Password character rules
- minLength int? - Minimum number of characters a password must contain
- rejectDictionaryWords boolean? - Determines whether a password must NOT contain word(s) from a dictionary
- rejectKeyboardPatterns boolean? - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean? - Determines whether a password must NOT contain user info (first name, last name, email, user name)
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: SoftwareVersionData![](/images/permalink.svg)
Software version information
Fields
- buildDate string - Build date
- isDracoonCloud boolean? - Since v4.24.0 Determines if the DRACOON Core is deployed in the cloud environment
- restApiVersion string - REST API version
- scmRevisionNumber string - Revision number
- sdsServerVersion string - DRACOON server version
dracoon.public: SubscribedDownloadShare![](/images/permalink.svg)
Subscribed download share information
Fields
- authParentId int? - Auth parent room ID
- id int - Share ID
dracoon.public: SubscribedDownloadShareList![](/images/permalink.svg)
List of subscribed download shares
Fields
- items SubscribedDownloadShare[] - List of subscribed download shares
- range Range - Range information
dracoon.public: SubscribedNode![](/images/permalink.svg)
Subscribed node information
Fields
- authParentId int? - Auth parent room ID
- id int - Node ID
- 'type string? - Node type
dracoon.public: SubscribedNodeList![](/images/permalink.svg)
List of subscribed nodes
Fields
- items SubscribedNode[] - List of subscribed nodes
- range Range - Range information
dracoon.public: SubscribedUploadShare![](/images/permalink.svg)
Subscribed upload share information
Fields
- id int - Share ID
- targetNodeId int? - Target room or folder ID
dracoon.public: SubscribedUploadShareList![](/images/permalink.svg)
List of subscribed upload shares
Fields
- items SubscribedUploadShare[] - List of subscribed upload shares
- range Range - Range information
dracoon.public: SyslogConfig![](/images/permalink.svg)
Syslog settings
Fields
- enabled boolean? - Is syslog enabled?
- host string? - Syslog server (IP or FQDN)
- logIpEnabled boolean? - Determines whether user’s IP address is logged.
- port int? - Syslog server port
- protocol string? - Protocol to connect to syslog server
dracoon.public: SyslogEvent![](/images/permalink.svg)
Syslog event information
Deprecated
Fields
- attribute1 string? - Attribute 1
- attribute2 string? - Attribute 2
- attribute3 string? - Attribute 3
- authParentSource string? - Auth parent source ID
- authParentTarget string? - Auth parent target ID
- customerId int? - Unique identifier for the customer
- id int - Event ID
- message string - Event description
- objectId1 int? - Object ID 1
- objectId2 int? - Object ID 2
- objectName1 string? - Object name 1
- objectName2 string? - Object type 2
- objectType1 int? - Object type 1
- objectType2 int? - Object type 2
- operationId int? - Operation type ID
- operationName string? - Operation name
- status int? - Operation status:
-
0
- Success -
2
- Error
-
- time string - Event timestamp
- userClient string? - Client
- userId int - Unique identifier for the user
- userIp string? - User IP
- userName string? - Username
dracoon.public: SyslogEventList![](/images/permalink.svg)
List of syslog events
Deprecated
Fields
- items SyslogEvent[] - List of log events
- range Range - Range information
dracoon.public: SystemDefaults![](/images/permalink.svg)
System defaults
Fields
- downloadShareDefaultExpirationPeriod int? - Default expiration period for Download Shares in days.
- fileDefaultExpirationPeriod int? - Default expiration period for all uploaded files in days.
- hideLoginInputFields boolean? - Since v4.13.0 Defines if login fields should be hidden
- languageDefault string? - Define which language should be default.
- nonmemberViewerDefault boolean? - Since v4.12.0 Defines if new users get the role Non Member Viewer by default
- uploadShareDefaultExpirationPeriod int? - Default expiration period for Upload Shares in days.
dracoon.public: SystemInfo![](/images/permalink.svg)
System information (default language and authentication methods)
Fields
- authMethods AuthMethod[] - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- hideLoginInputFields boolean - Since v4.13.0 Defines if login fields should be hidden
- s3EnforceDirectUpload boolean - Since v4.15.0 Determines whether S3 direct upload is enforced or not
- s3Hosts string[] - Since v4.14.0 List of S3 Hosts for CSP header
- useS3Storage boolean - Since v4.21.0 Defines if S3 is used as storage backend
dracoon.public: TestActiveDirectoryConfigRequest![](/images/permalink.svg)
Request model for testing connection for Active Directory configuration
Fields
- ldapUsersDomain string - Search scope of Active Directory; only users below this node can log on.
- serverAdminName string - Distinguished Name (DN) of Active Directory administrative account
- serverAdminPassword string - Password of Active Directory administrative account
- serverIp string - IPv4 or IPv6 address or host name
- serverPort int - Port
- sslFingerPrint string? - SSL finger print of Active Directory server.
Mandatory for LDAPS connections.
Format:
Algorithm/Fingerprint
- useLdaps boolean(default false) - Determines whether LDAPS should be used instead of plain LDAP.
dracoon.public: TestActiveDirectoryConfigResponse![](/images/permalink.svg)
Response model for testing connection for Active Directory configuration
Fields
- ldapUsersDomain string - Search scope of Active Directory; only users below this node can log on.
- serverAdminName string - Distinguished Name (DN) of Active Directory administrative account
- serverAdminPassword string - Password of Active Directory administrative account
- serverIp string - IPv4 or IPv6 address or host name
- serverPort int - Port
- sslFingerPrint string? - SSL finger print of Active Directory server.
Mandatory for LDAPS connections.
Format:
Algorithm/Fingerprint
- useLdaps boolean - Determines whether LDAPS should be used instead of plain LDAP.
dracoon.public: ThirdPartyDependenciesData![](/images/permalink.svg)
Third-party dependency information
Fields
- artifactId string - Third party dependencies artifactId
- description string - Third party dependencies description
- groupId string - Third party dependencies groupId
- id string - Third party dependencies id
- licenses string[] - Third party dependencies licenses type
- name string - Third party dependencies name
- 'type string - Third party dependencies type
- url string - Third party dependencies url
- 'version string - Third party dependencies version
dracoon.public: UpdateActiveDirectoryConfigRequest![](/images/permalink.svg)
Request model for updating an Active Directory configuration
Fields
- adExportGroup string? - If
userImport
is set totrue
, the user must be member of this Active Directory group to receive a newly created DRACOON account.
- alias string? - Unique name for an Active Directory configuration
- createHomeFolder boolean? - DEPRECATED, will be ignored Determines whether a room is created for each user that is created by automatic import (like a home folder). Room's name will equal the user's login name.
- homeFolderParent int? - DEPRECATED, will be ignored ID of the room in which the individual rooms for users will be created.
- ldapUsersDomain string? - Search scope of Active Directory; only users below this node can log on.
- sdsImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- serverAdminName string? - Distinguished Name (DN) of Active Directory administrative account
- serverAdminPassword string? - Password of Active Directory administrative account
- serverIp string? - IPv4 or IPv6 address or host name
- serverPort int? - Port
- sslFingerPrint string? - SSL finger print of Active Directory server.
Mandatory for LDAPS connections.
Format:
Algorithm/Fingerprint
- useLdaps boolean? - Determines whether LDAPS should be used instead of plain LDAP.
- userFilter string? - Name of Active Directory attribute that is used as login name.
- userImport boolean? - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
dracoon.public: UpdateAuthTokenRestrictions![](/images/permalink.svg)
Request model for updating auth token settings
Fields
- accessTokenValidity int? - Since v4.13.0 Restricted OAuth access token validity (in seconds)
- overwriteEnabled boolean - Since v4.13.0 Defines if OAuth token restrictions are enabled
- refreshTokenValidity int? - Since v4.13.0 Restricted OAuth refresh token validity (in seconds)
dracoon.public: UpdateCustomerRequest![](/images/permalink.svg)
Request model for updating a customer
Fields
- companyName string? - Company name
- customerContractType string - Customer type
- isLocked boolean(default false) - Customer is locked:
-
false
- unlocked -
true
- locked
-
- lockStatus boolean(default false) - Deprecated since v4.7.0
Customer lock status:
-
false
- unlocked -
true
- locked
isLocked
instead. All users of this customer will be blocked and can not login anymore. -
- providerCustomerId string? - Provider customer ID
- quotaMax int? - Maximal disc space which can be allocated by customer in bytes. -1 for unlimited
- userMax int? - Maximal number of users
- webhooksMax int? - Since v4.19.0 Maximal number of webhooks
dracoon.public: UpdateCustomerResponse![](/images/permalink.svg)
Customer information
Fields
- activationCode string? - Deprecated since v4.8.0
Customer activation code string:
-
valid only for types
free
anddemo
-
for
pay
customers it is empty
-
valid only for types
- companyName string - Company name
- createdAt string? - Creation date
- customerAttributes CustomerAttributes? - List of customer attributes
- customerContractType string - Customer type
- customerUuid string - Since v4.21.0 Customer UUID
- id int - Unique identifier for the customer
- isLocked boolean(default false) - Customer is locked:
-
false
- unlocked -
true
- locked
-
- lockStatus boolean - Deprecated since v4.7.0
Customer lock status:
-
false
- unlocked -
true
- locked
isLocked
instead. All users of this customer will be blocked and can not login anymore. -
- providerCustomerId string? - Provider customer ID
- quotaMax int - Maximal disc space which can be allocated by customer in bytes. -1 for unlimited
- trialDays int? - Number of days left for trial period (relevant only for type
demo
) (not used)
- updatedAt string? - Modification date
- userMax int - Maximal number of users
- webhooksMax int? - Since v4.19.0 Maximal number of webhooks
dracoon.public: UpdateDownloadShareRequest![](/images/permalink.svg)
Request model for updating a Download Share
Fields
- defaultCountry string? - Country shorthand symbol (cf. ISO 3166-2)
- expiration ObjectExpiration? - Expiration information
- internalNotes string? - Since v4.11.0 Internal notes
- maxDownloads int? - Max allowed downloads
- name string? - Alias name
- notes string? - User notes
- notifyCreator boolean? - Deprecated since v4.20.0 Notify creator on every download.
- password string? - Access password, not allowed for encrypted shares
- receiverLanguage string? - Language tag for messages to receiver
- resetMaxDownloads boolean? - Set 'true' to reset 'maxDownloads' for Download Share.
- resetPassword boolean? - Set 'true' to reset 'password' for Download Share.
- showCreatorName boolean? - Show creator first and last name.
- showCreatorUsername boolean? - Show creator email address.
- textMessageRecipients string[]? - List of recipient FQTNs E.123 / E.164 Format
dracoon.public: UpdateDownloadSharesBulkRequest![](/images/permalink.svg)
Request model for updating a list of Download Shares
Fields
- expiration ObjectExpiration? - Expiration information
- maxDownloads int? - Max allowed downloads
- objectIds int[] - List of ids
- resetMaxDownloads boolean? - Set 'true' to reset 'maxDownloads' for Download Share.
- showCreatorName boolean? - Show creator first and last name.
- showCreatorUsername boolean? - Show creator email address.
dracoon.public: UpdateEncryptionPasswordPolicies![](/images/permalink.svg)
Request model for updating encryption password policies
Fields
- characterRules CharacterRules? - Password character rules
- minLength int? - Minimum number of characters a password must contain
- rejectKeyboardPatterns boolean? - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean? - Determines whether a password must NOT contain user info (first name, last name, email, user name)
dracoon.public: UpdateEventlogConfig![](/images/permalink.svg)
Request model for updating eventlog settings
Fields
- enabled boolean? - Is eventlog enabled?
- logIpEnabled boolean? - Determines whether user’s IP address is logged.
- retentionPeriod int? - Retention period (in days) of event log entries. After that period, all entries are deleted. Recommended value: 7
dracoon.public: UpdateFavoritesBulkRequest![](/images/permalink.svg)
Request model for updating favorites
Fields
- isFavorite boolean - Sets the favorite attribute to true or false on each file in an array of nodes.
- objectIds int[] - List of ids
dracoon.public: UpdateFileRequest![](/images/permalink.svg)
Request model for updating file's metadata
Fields
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- expiration ObjectExpiration? - Expiration information
- name string? - File name
- notes string? - User notes Use empty string to remove.
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: UpdateFilesBulkRequest![](/images/permalink.svg)
Request model for updating files
Fields
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- expiration ObjectExpiration? - Expiration information
- objectIds int[] - List of ids
dracoon.public: UpdateFolderRequest![](/images/permalink.svg)
Request model for updating folder's metadata
Fields
- name string? - Folder name
- notes string? - User notes Use empty string to remove.
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: UpdateGeneralSettings![](/images/permalink.svg)
Request model for updating general settings
Fields
- authTokenRestrictions UpdateAuthTokenRestrictions? - Request model for updating auth token settings
- cryptoEnabled boolean? - Activation status of client-side encryption. Can only be enabled once; disabling is not possible.
- emailNotificationButtonEnabled boolean? - Enable email notification button
- eulaEnabled boolean? - Each user has to confirm the EULA at first login.
- hideLoginInputFields boolean? - Deprecated since v4.13.0 Defines if login fields should be hidden
- mediaServerEnabled boolean? - Deprecated since v4.12.0 Determines if the media server is enabled
- s3TagsEnabled boolean? - Since v4.9.0 Defines if S3 tags are enabled
- sharePasswordSmsEnabled boolean? - Allow sending of share passwords via SMS
- weakPasswordEnabled boolean? - Deprecated since v4.14.0
Allow weak password
- A weak password has to fulfill the following criteria:
- is at least 8 characters long
- contains letters and numbers
- A strong password has to fulfill the following criteria in addition:
- contains at least one special character
- contains upper and lower case characters
PUT /system/config/policies/passwords
API to change configured password policies.
dracoon.public: UpdateGroupRequest![](/images/permalink.svg)
Request model for updating group's metadata
Fields
- expiration ObjectExpiration? - Expiration information
- name string? - Group name
dracoon.public: UpdateLoginPasswordPolicies![](/images/permalink.svg)
Request model for updating login password policies
Fields
- characterRules CharacterRules? - Password character rules
- enforceLoginPasswordChange boolean? - Deprecated since v4.24.0 Determines whether a login password change should be enforced for all users Only takes effect, if login password policies get stricter
- minLength int? - Minimum number of characters a password must contain
- numberOfArchivedPasswords int? - Number of passwords to archive
(must be between
0
and10
;0
means that password history is disabled)
- passwordExpiration PasswordExpiration? - Password expiration information
- rejectDictionaryWords boolean? - Determines whether a password must NOT contain word(s) from a dictionary
- rejectKeyboardPatterns boolean? - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean? - Determines whether a password must NOT contain user info (first name, last name, email, user name)
- userLockout UserLockout? - User lockout information
dracoon.public: UpdateOAuthClientRequest![](/images/permalink.svg)
Request model for updating an OAuth client
Fields
- accessTokenValidity int? - Validity of the access token in seconds.
- approvalValidity int? - Since v4.22.0 Validity of the approval interval in seconds.
- clientName string? - Name, which is shown at the client configuration and authorization.
- clientSecret string? - Secret, which client uses at authentication.
- clientType string? - Determines whether client is a confidential or public client.
- isEnabled boolean? - Determines whether client is enabled.
- redirectUris string[]? - URIs, to which a user is redirected after authorization.
- refreshTokenValidity int? - Validity of the refresh token in seconds.
dracoon.public: UpdateOpenIdIdpConfigRequest![](/images/permalink.svg)
Request model for updating an OpenID Connect IDP configuration
Fields
- authorizationEndPointUrl string? - URL of the authorization endpoint
- clientId string? - ID of the OpenID client
- clientSecret string? - Secret, which client uses at authentication.
- fallbackMappingClaim string? - Name of the claim which is used for the user mapping fallback.
- flow string? - Since v4.11.0 Flow, which is used at authentication
- issuer string? - Issuer identifier of the IDP The value is a case sensitive URL.
- jwksEndPointUrl string? - URL of the JWKS endpoint
- mappingClaim string? - Name of the claim which is used for the user mapping.
- name string? - Name of the IDP
- redirectUris string[]? - URIs, to which a user is redirected after authorization.
- resetFallbackMappingClaim boolean? - Set
true
to resetfallbackMappingClaim
.
- scopes string[]? - List of requested scopes
Usually
openid
and the names of the requested claims.
- tokenEndPointUrl string? - URL of the token endpoint
- userImportEnabled boolean? - Determines if a DRACOON account is automatically created for a new user who successfully logs on with his / her AD / IDP account.
- userImportGroup int? - User group that is assigned to users who are created by automatic import.
Reset with
0
- userInfoEndPointUrl string? - URL of the user info endpoint
- userInfoSource string? - Since v4.23.0 Source, which is used to get user information at the import or update of a user.
- userManagementUrl string? - URL of the user management UI. Use empty string to remove.
- userUpdateEnabled boolean? - Determines if the DRACOON account is updated with data from AD / IDP.
For OpenID Connect, the scopes
email
andprofile
are needed.
dracoon.public: UpdatePasswordPoliciesConfig![](/images/permalink.svg)
Request model for updating a set of password policies
Fields
- encryptionPasswordPolicies UpdateEncryptionPasswordPolicies? - Request model for updating encryption password policies
- loginPasswordPolicies UpdateLoginPasswordPolicies? - Request model for updating login password policies
- sharesPasswordPolicies UpdateSharesPasswordPolicies? - Request model for updating shares password policies
dracoon.public: UpdateRoomRequest![](/images/permalink.svg)
Request model for updating room's metadata
Fields
- name string? - Name
- notes string? - User notes Use empty string to remove.
- quota int? - Quota in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system
dracoon.public: UpdateRoomWebhookRequest![](/images/permalink.svg)
Request model for handling webhook assignments
Fields
- items RoomWebhookAssignment[] - Assign a webhook to a room to use it for node actions within the room
dracoon.public: UpdateSharesPasswordPolicies![](/images/permalink.svg)
Request model for updating shares password policies
Fields
- characterRules CharacterRules? - Password character rules
- minLength int? - Minimum number of characters a password must contain
- rejectDictionaryWords boolean? - Determines whether a password must NOT contain word(s) from a dictionary
- rejectKeyboardPatterns boolean? - Determines whether a password must NOT contain keyboard patterns (e.g.
qwertz
,asdf
) (min. 4 character pattern)
- rejectUserInfo boolean? - Determines whether a password must NOT contain user info (first name, last name, email, user name)
dracoon.public: UpdateSubscriptionsBulkRequest![](/images/permalink.svg)
Request model for updating subscriptions
Fields
- isSubscribed boolean - Creates or deletes a subscription on each item in an array of objects.
- objectIds int[] - List of ids
dracoon.public: UpdateSyslogConfig![](/images/permalink.svg)
Request model for updating syslog settings
Fields
- enabled boolean? - Is syslog enabled?
- host string? - Syslog server (IP or FQDN)
- logIpEnabled boolean? - Determines whether user’s IP address is logged.
- port int? - Syslog server port
- protocol string? - Protocol to connect to syslog server
dracoon.public: UpdateSystemDefaults![](/images/permalink.svg)
Request model for updating system defaults
Fields
- downloadShareDefaultExpirationPeriod int? - Default expiration period for Download Shares in days.
- fileDefaultExpirationPeriod int? - Default expiration period for all uploaded files in days.
- languageDefault string? - Define which language should be default.
- nonmemberViewerDefault boolean? - Since v4.12.0 Defines if new users get the role Non Member Viewer by default
- uploadShareDefaultExpirationPeriod int? - Default expiration period for Upload Shares in days.
dracoon.public: UpdateUploadShareRequest![](/images/permalink.svg)
Request model for updating an Upload Share
Fields
- defaultCountry string? - Country shorthand symbol (cf. ISO 3166-2)
- expiration ObjectExpiration? - Expiration information
- filesExpiryPeriod int? - Number of days after which uploaded files expire
- internalNotes string? - Since v4.11.0 Internal notes
- maxSize int? - Maximal total size of uploaded files (in bytes)
- maxSlots int? - Maximal amount of files to upload
- name string? - Alias name
- notes string? - User notes
- notifyCreator boolean? - Deprecated since v4.20.0 Notify creator on every upload.
- password string? - Password
- receiverLanguage string? - Language tag for messages to receiver
- resetFilesExpiryPeriod boolean? - Set 'true' to reset 'filesExpiryPeriod' for Upload Share
- resetMaxSize boolean? - Set 'true' to reset 'maxSize' for Upload Share
- resetMaxSlots boolean? - Set 'true' to reset 'maxSlots' for Upload Share
- resetPassword boolean? - Set 'true' to reset 'password' for Upload Share.
- showCreatorName boolean? - Show creator first and last name.
- showCreatorUsername boolean? - Show creator email address.
- showUploadedFiles boolean? - Allow display of already uploaded files
- textMessageRecipients string[]? - List of recipient FQTNs E.123 / E.164 Format
dracoon.public: UpdateUploadSharesBulkRequest![](/images/permalink.svg)
Request model for updating a list of Download Shares
Fields
- expiration ObjectExpiration? - Expiration information
- filesExpiryPeriod int? - Number of days after which uploaded files expire
- maxSize int? - Maximal total size of uploaded files (in bytes)
- maxSlots int? - Maximal amount of files to upload
- objectIds int[] - List of ids
- resetFilesExpiryPeriod boolean? - Set 'true' to reset 'filesExpiryPeriod' for Upload Share
- resetMaxSize boolean? - Set 'true' to reset 'maxSize' for Upload Share
- resetMaxSlots boolean? - Set 'true' to reset 'maxSlots' for Upload Share
- showCreatorName boolean? - Show creator first and last name.
- showCreatorUsername boolean? - Show creator email address.
- showUploadedFiles boolean? - Allow display of already uploaded files
dracoon.public: UpdateUserAccountRequest![](/images/permalink.svg)
Request model for updating user account information
Fields
- acceptEULA boolean? - Accept EULA
Present, if EULA is system global active.
cf.
GET system/config/settings/general
-eulaEnabled
If accepted can not be undone.
- email string? - Email
- firstName string? - User first name
- gender string? - Deprecated since v4.12.0
Gender
Do NOT use
gender
! It will be ignored.
- language string? - Since v4.20.0 IETF language tag
- lastName string? - User last name
- login string? - Deprecated since v4.13.0 User login name
- phone string? - Phone number
- title string? - Deprecated since v4.18.0 Job title
- userName string? - Since v4.13.0 Username
dracoon.public: UpdateUserRequest![](/images/permalink.svg)
Request model for updating user's metadata
Fields
- authData UserAuthDataUpdateRequest? - User Authentication Data Update Request
- authMethods UserAuthMethod[]? - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- email string? - Email
- expiration ObjectExpiration? - Expiration information
- firstName string? - User first name
- gender string? - Deprecated since v4.12.0
Gender
Do NOT use
gender
! It will be ignored.
- isLocked boolean? - User is locked:
-
false
- unlocked -
true
- locked
-
- lastName string? - User last name
- lockStatus int? - Deprecated since v4.7.0
User lock status:
-
0
- locked -
1
- Web access allowed -
2
- Web and mobile access allowed
isLocked
instead. -
- phone string? - Phone number
- receiverLanguage string? - IETF language tag
- title string? - Deprecated since v4.18.0 Job title
- userName string? - Since v4.13.0 Username
dracoon.public: UpdateWebhookRequest![](/images/permalink.svg)
Request model for updating a webhook
Fields
- eventTypeNames string[]? - List of names of event types
- isEnabled boolean? - Is enabled
- name string? - Name
- secret string? - Secret; used for event message signatures
- triggerExampleEvent boolean? - If set to true, an example event is being created
- url string? - URL (must begin with the
HTTPS
scheme)
dracoon.public: UploadShare![](/images/permalink.svg)
Upload Share information
Fields
- accessKey string - Share access key to generate secure link
- cntFiles int? - Total amount of existing files uploaded with this share.
- cntUploads int? - Total amount of uploads conducted with this share.
- createdAt string - Creation date
- createdBy UserInfo - User information
- dataUrl string? - Upload Share URL
- expireAt string? - Expiration date
- filesExpiryPeriod int? - Number of days after which uploaded files expire
- id int - Share ID
- internalNotes string? - Since v4.11.0 Internal notes
- isEncrypted boolean? - Encryption state
- isProtected boolean - Is share protected by password
- maxSize int? - Maximal total size of uploaded files (in bytes)
- maxSlots int? - Maximal amount of files to upload
- name string - Alias name
- notes string? - User notes
- notifyCreator boolean - Deprecated since v4.20.0 Notify creator on every upload.
- recipients string? - Deprecated since v4.11.0 CSV string of recipient email addresses
- showCreatorName boolean? - Since v4.11.0 Show creator first and last name.
- showCreatorUsername boolean? - Since v4.11.0 Show creator email address.
- showUploadedFiles boolean? - Allow display of already uploaded files
- smsRecipients string? - Deprecated since v4.11.0 CSV string of recipient MSISDNs
- targetId int - Target room or folder ID
- targetPath string? - Path to shared upload node
- targetType string? - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: UploadShareLinkEmail![](/images/permalink.svg)
Request model for sending an email of an Upload Share link
Fields
- body string - Notification email content
- receiverLanguage string? - Language tag for messages to receiver
- recipients string[] - List of recipient email addresses
dracoon.public: UploadShareList![](/images/permalink.svg)
List of Upload Shares
Fields
- items UploadShare[] - List of Upload Shares
- range Range - Range information
dracoon.public: UploadsTokenBody![](/images/permalink.svg)
Fields
- file string? -
dracoon.public: UploadsUploadIdBody![](/images/permalink.svg)
Fields
- file string? -
dracoon.public: UserAccount![](/images/permalink.svg)
User information
Fields
- authData UserAuthData - User Authentication Data
- authMethods UserAuthMethod[]? - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- customer CustomerData - Customer information
- email string? - Email
- expireAt string? - Expiration date
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0 Gender
- hasManageableRooms boolean - User has manageable rooms
- homeRoomId int? - Homeroom ID
- id int - Unique identifier for the user
- isEncryptionEnabled boolean? - User has generated private key. Possible if client-side encryption is active for this customer
- isLocked boolean - User is locked:
-
false
- unlocked -
true
- locked
-
- language string - Since v4.20.0 IETF language tag
- lastLoginFailAt string? - Last failed logon date
- lastLoginFailIp string? - Deprecated since v4.6.0 Last failed logon IP address
- lastLoginSuccessAt string? - Last successful logon date
- lastLoginSuccessIp string? - Deprecated since v4.6.0 Last successful logon IP address
- lastName string - User last name
- lockStatus int - Deprecated since v4.7.0
User lock status:
-
0
- locked -
1
- Web access allowed -
2
- Web and mobile access allowed
isLocked
instead. -
- login string? - Deprecated since v4.13.0 User login name
- mustSetEmail boolean(default false) - Since v4.13.0
If
true
, the user must set theemail
at the first login.
- needsToAcceptEULA boolean? - User has accepted EULA.
Present, if EULA is system global active.
cf.
GET system/config/settings/general
-eulaEnabled
- needsToChangePassword boolean - Deprecated since v4.13.0 Determines whether user has to change his / her password
- needsToChangeUserName boolean(default false) - Deprecated since v4.13.0
If
true
, the user must change theuserName
at the first login.
- phone string? - Phone number
- title string? - Deprecated since v4.18.0 Job title
- userAttributes UserAttributes? - User custom attributes (list of key-value pairs)
- userGroups UserGroup[]? - All groups the user is member of
- userName string - Since v4.13.0 Username
- userRoles RoleList - List of roles
dracoon.public: UserAttributes![](/images/permalink.svg)
User custom attributes (list of key-value pairs)
Deprecated
Fields
- items KeyValueEntry[] - List of key-value pairs
dracoon.public: UserAuthData![](/images/permalink.svg)
User Authentication Data
Fields
- adConfigId int? - ID of the user's Active Directory.
- login string? - User login name
- method string - Authentication method
Authentication methods:
-
basic
-
active_directory
-
radius
-
openid
-
- mustChangePassword boolean? - Determines whether user has to change his / her password
-
default:
true
forbasic
auth type -
default:
false
foractive_directory
,openid
andradius
auth types
-
default:
- oidConfigId int? - ID of the user's OIDC provider.
- password string? - Password (only relevant for
basic
authentication type) NOT your Active Directory, OpenID or RADIUS password!
dracoon.public: UserAuthDataUpdateRequest![](/images/permalink.svg)
User Authentication Data Update Request
Fields
- adConfigId int? - ID of the user's Active Directory.
- login string? - User login name
- method string? - Authentication method
Authentication methods:
-
basic
-
active_directory
-
radius
-
openid
-
- oidConfigId int? - ID of the user's OIDC provider.
dracoon.public: UserAuthMethod![](/images/permalink.svg)
Authentication method
Deprecated
Fields
- authId string - Authentication method
Authentication methods:
-
basic
-
active_directory
-
radius
-
openid
-
- isEnabled boolean - Is enabled
- options KeyValueEntry[]? - Authentication method options
dracoon.public: UserData![](/images/permalink.svg)
User information
Fields
- authData UserAuthData - User Authentication Data
- authMethods UserAuthMethod[]? - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- avatarUuid string - Since v4.11.0 Avatar UUID
- email string? - Email
- expireAt string? - Expiration date
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0 Gender
- hasManageableRooms boolean? - User has manageable rooms
- homeRoomId int? - Homeroom ID
- id int - Unique identifier for the user
- isEncryptionEnabled boolean? - User has generated private key. Possible if client-side encryption is active for this customer
- isLocked boolean - User is locked:
-
false
- unlocked -
true
- locked
-
- lastLoginSuccessAt string? - Last successful logon date
- lastName string - User last name
- lockStatus int - Deprecated since v4.7.0
User lock status:
-
0
- locked -
1
- Web access allowed -
2
- Web and mobile access allowed
isLocked
instead. -
- login string? - Deprecated since v4.13.0 User login name
- phone string? - Phone number
- publicKeyContainer PublicKeyContainer? - Public key container
- title string? - Deprecated since v4.18.0 Job title
- userAttributes UserAttributes? - User custom attributes (list of key-value pairs)
- userName string - Since v4.13.0 Username
- userRoles RoleList? - List of roles
dracoon.public: UserFileKey![](/images/permalink.svg)
User file key
Fields
- fileKey FileKey - File key information
- userId int - Unique identifier for the user
dracoon.public: UserFileKeyList![](/images/permalink.svg)
List of user file keys
Deprecated
Fields
- items UserFileKey[]? - List of user file keys
dracoon.public: UserFileKeySetBatchRequest![](/images/permalink.svg)
List of request models for setting a user file key(s)
Fields
- items UserFileKeySetRequest[] - List of user file keys
dracoon.public: UserFileKeySetRequest![](/images/permalink.svg)
Request model for setting a user file key
Fields
- fileId int - File ID
- fileKey FileKey - File key information
- userId int - Unique identifier for the user
dracoon.public: UserGroup![](/images/permalink.svg)
Group information
Fields
- id int - Unique identifier for the group
- isMember boolean - Determines whether user is a member of the group or not
- name string - Group name
dracoon.public: UserGroupList![](/images/permalink.svg)
List of groups
Fields
- items UserGroup[] - List of user-group mappings
- range Range - Range information
dracoon.public: UserIdFileIdItem![](/images/permalink.svg)
User ID and file ID mapping
Fields
- fileId int? - File ID
- userId int? - Unique identifier for the user
dracoon.public: UserIds![](/images/permalink.svg)
List of user IDs
Fields
- ids int[] - List of user IDs
dracoon.public: UserInfo![](/images/permalink.svg)
User information
Fields
- avatarUuid string - Since v4.11.0 Avatar UUID
- displayName string? - Deprecated since v4.11.0
Display name
use other fields from
UserInfo
instead to combine a display name
- email string? - Since v4.11.0 Email
- firstName string - Since v4.11.0
User first name (mandatory if
userType
isinternal
)
- id int - Unique identifier for the user
- lastName string - Since v4.11.0
User last name (mandatory if
userType
isinternal
)
- title string? - Deprecated since v4.18.0 Job title
- userName string - Since v4.13.0
Username (only returned for
internal
users)
- userType string - Since v4.11.0
User type:
-
internal
- ordinary DRACOON user -
external
- external user without DRACOON account -
system
- system user (non human ) -
deleted
- deleted DRACOON user
-
dracoon.public: UserItem![](/images/permalink.svg)
User information
Fields
- avatarUuid string - Since v4.11.0 Avatar UUID
- createdAt string? - Creation date
- email string? - Email
- expireAt string? - Expiration date
- firstName string - User first name
- gender string(default "n") - Deprecated since v4.12.0 Gender
- hasManageableRooms boolean? - Deprecated since v4.27.0 User has manageable rooms
- homeRoomId int? - Homeroom ID
- id int - Unique identifier for the user
- isEncryptionEnabled boolean? - User has generated private key. Possible if client-side encryption is active for this customer
- isLocked boolean - User is locked:
-
false
- unlocked -
true
- locked
-
- lastLoginSuccessAt string? - Last successful logon date
- lastName string - User last name
- lockStatus int - Deprecated since v4.7.0
User lock status:
-
0
- locked -
1
- Web access allowed -
2
- Web and mobile access allowed
isLocked
instead. -
- login string - Deprecated since v4.13.0 User login name
- phone string? - Phone number
- title string? - Deprecated since v4.18.0 Job title
- userAttributes UserAttributes? - User custom attributes (list of key-value pairs)
- userName string - Since v4.13.0 Username
- userRoles RoleList? - List of roles
dracoon.public: UserKeyPairContainer![](/images/permalink.svg)
Key pair container
Fields
- privateKeyContainer PrivateKeyContainer - Private key container
- publicKeyContainer PublicKeyContainer - Public key container
dracoon.public: UserList![](/images/permalink.svg)
List of users
Fields
- items UserItem[] - List of users
- range Range - Range information
dracoon.public: UserLockout![](/images/permalink.svg)
User lockout information
Fields
- enabled boolean - Determines whether user lockout is enabled
- lockoutPeriod int? - Amount of minutes a user has to wait to make another login attempt after
maxNumberOfLoginFailures
has been exceeded
- maxNumberOfLoginFailures int? - Maximum allowed number of failed login attempts
dracoon.public: UserUserPublicKey![](/images/permalink.svg)
Public key information
Fields
- id int? - Unique identifier for the user
- publicKeyContainer PublicKeyContainer? - Public key container
dracoon.public: UserUserPublicKeyList![](/images/permalink.svg)
List of user public keys
Fields
- items UserUserPublicKey[] - List of user public keys
dracoon.public: ViolatedPasswordPolicy![](/images/permalink.svg)
Violated password policy information
Fields
- message string? - Message from password validator
- name string? - Name of the violated password policy
dracoon.public: Webhook![](/images/permalink.svg)
Webhook information
Fields
- createdAt string - Creation date
- createdBy UserInfo? - User information
- eventTypeNames string[] - List of names of event types
- expireAt string - Expiration date / time
- failStatus int? - Last HTTP status code when a webhook is disabled due to delivery failures
- id int - ID
- isEnabled boolean - Is enabled
- name string - Name
- secret string? - Secret; used for event message signatures
- updatedAt string - Modification date
- updatedBy UserInfo? - User information
- url string - URL
dracoon.public: WebhookList![](/images/permalink.svg)
List of webhooks
Fields
- items Webhook[] - List of webhooks
- range Range - Range information
dracoon.public: ZipDownloadRequest![](/images/permalink.svg)
Request model for ZIP download
Fields
- nodeIds int[] - List of node IDs
Union types![](/images/permalink.svg)
dracoon.public: InlineResponse400![](/images/permalink.svg)
InlineResponse400
dracoon.public: InlineResponse4001![](/images/permalink.svg)
InlineResponse4001
Import
import ballerinax/dracoon.public;
Metadata
Released date: over 1 year ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Content & Files/File Management & Storage
Cost/Paid
Contributors