@datafire/dracoon_team v4.0.0

@datafire/dracoon_team

Client library for DRACOON API

Installation and Usage

npm install --save @datafire/dracoon_team

let dracoon_team = require('@datafire/dracoon_team').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

REST Web Services for DRACOONbuilt at: 2020-11-17 08:47:09This page provides an overview of all available and documented DRACOON APIs, which are grouped by tags.Each tag provides a collection of APIs that are intended for a specific area of the DRACOON.Developer Information  Get SDKs on GitHubTerms of service

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

dracoon_team.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

dracoon_team.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

login

Description:

Authenticates user and provides an authentication token (X-Sds-Auth-Token) that is required for the most operations.

Precondition:

Existing user that is NOT locked.

Postcondition:

User is logged in.

Further Information:

The provided token is valid for two hours, every usage resets this period to two full hours again.
Logging off invalidates the token.

Available authentication methods:

dracoon_team.login({
  "body": {
    "password": ""
  }
}, context)

Input

• input object
  • body required LoginRequest

Output

• output LoginResponse

initiateOpenIdLogin

Description:

This is the first step of the OpenID Connect authentication.
The user is send to the OpenID Connect identity provider to authenticate himself and retrieve an authorization code.

Precondition:

None.

Postcondition:

User is redirected to OpenID Connect identity provider to authenticate himself.

Further Information:

None.

dracoon_team.initiateOpenIdLogin({
  "issuer": "",
  "redirect_uri": "",
  "language": "",
  "test": true
}, context)

Input

• input object
  • issuer required string: Issuer identifier of the OpenID Connect identity provider
  • redirect_uri required string: Redirect URI to complete the OpenID Connect authentication
  • language required string: Language ID or ISO 639-1 code
  • test required boolean: Flag to test the authentication parameters.

Output

Output schema unknown

completeOpenIdLogin

Description:

This is the second step of the OpenID Connect authentication.
The user hands over the authorization code and is logged in.

Precondition:

Existing user with activated OpenID Connect authentication that is NOT locked.

Postcondition:

User is logged in.

Further Information:

None.

dracoon_team.completeOpenIdLogin({
  "code": "",
  "state": ""
}, context)

Input

• input object
  • code required string: Authorization code
  • id_token string: Identity token
  • state required string: Authentication state

Output

• output LoginResponse

requestOpenIdAuthResources

Description:

Provides information about OpenID Connect authentication options.

Precondition:

None.

Postcondition:

List of available OpenID Connect Providers is returned.

Further Information:

Empty list is returned if OpenID Connect is NOT configured.

dracoon_team.requestOpenIdAuthResources(null, context)

Input

This action has no parameters

Output

• output OpenIdAuthResources

ping

Description:

Test connection to DRACOON Core Service.

Precondition:

None.

Postcondition:

200 OK with current date string is returned if successful.

Further Information:

None.

dracoon_team.ping(null, context)

Input

This action has no parameters

Output

• output string

recoverUserName

Description:

Request an email with the user names of all accounts connected to the email.

Precondition:

Valid email address.

Postcondition:

An email is sent to the provided address, with a list of account user names connected to it.

Further Information:

None.

dracoon_team.recoverUserName({
  "body": {
    "email": ""
  }
}, context)

Input

• input object
  • body required RecoverUserNameRequest

Output

Output schema unknown

requestPasswordReset

Description:

Request an email with a password reset token for a certain user to reset password.

Precondition:

Registered user account.

Postcondition:

Provided user receives email with password reset token.

Further Information:

None.

dracoon_team.requestPasswordReset({
  "body": {}
}, context)

Input

• input object
  • body required ResetPasswordRequest

Output

Output schema unknown

validateResetPasswordToken

Description:

Request all information for a password change dialogue e.g. real name of user.

Precondition:

User received a password reset token.

Postcondition:

Context information is returned.

Further Information:

None.

dracoon_team.validateResetPasswordToken({
  "token": ""
}, context)

Input

• input object
  • token required string: Password reset token

Output

• output ResetPasswordTokenValidateResponse

resetPassword

Description:

Resets user's password.

Precondition:

User received a password reset token.

Postcondition:

User's password is reset to the provided password.

Further Information:

Forbidden characters in passwords: &, ', <, >

dracoon_team.resetPassword({
  "token": "",
  "body": {
    "password": ""
  }
}, context)

Input

• input object
  • token required string: Password reset token
  • body required ResetPasswordWithTokenRequest

Output

Output schema unknown

requestSystemDefaultsInfo

Description:

Returns a list of configurable system default values.

Precondition:

Authenticated user.

Postcondition:

List of configurable default settings is returned.

Further Information:

None.

Configurable default values:

dracoon_team.requestSystemDefaultsInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output SystemDefaults

requestGeneralSettingsInfo

Description:

Returns a list of configurable general settings.

Precondition:

Authenticated user.

Postcondition:

List of configurable general settings is returned.

Further Information:

None.

Configurable general settings:

Deprecated general settings:

dracoon_team.requestGeneralSettingsInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output GeneralSettingsInfo

requestInfrastructurePropertiesInfo

Description:

Returns a list of read-only infrastructure properties.

Precondition:

Authenticated user.

Postcondition:

List of infrastructure properties is returned.

Further Information:

Source: api.properties

Read-only infrastructure properties:

dracoon_team.requestInfrastructurePropertiesInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output InfrastructureProperties

requestNotificationChannelsInfo

Description:

Retrieve a list of configured notification channels.

Precondition:

Authenticated user.

Postcondition:

List of notification channels is returned.

Further Information:

None.

dracoon_team.requestNotificationChannelsInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output NotificationChannelList

requestPasswordPoliciesConfigInfo

Description:

Retrieve a list of configured password policies for all password types:

• login
• shares
• encryption

Precondition:

Authenticated user.

Postcondition:

List of configured password policies is returned.

Further Information:

None.

Available password policies:

dracoon_team.requestPasswordPoliciesConfigInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output PasswordPoliciesConfig

requestS3TagsInfo

Description:

Retrieve all configured S3 tags.

Precondition:

Authenticated user.

Postcondition:

List of configured S3 tags is returned.

Further Information:

An empty list is returned if no S3 tags are found / configured.

dracoon_team.requestS3TagsInfo({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output S3TagList

requestSystemSettings

Description:

Returns a list of configurable system settings.

Precondition:

Right 🔓 read global config required.

Postcondition:

List of configurable settings is returned.

Further Information:

Check for every settings key new corresponding API and key below.

If eula_active is true, but NOT accepted yet, or password MUST be changed, only the following two values are returned:

• allow_system_global_weak_password
• eula_active

Configurable settings

Deprecated settings

dracoon_team.requestSystemSettings({}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token

Output

• output ConfigOptionList

updateSystemSettings

Description:

Update configurable settings.

Precondition:

Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required.

Postcondition:

One or more global settings gets changed.

Further Information:

This API is deprecated and will be removed in the future.
Check for every settings key new corresponding API and key below.

Configurable settings:

Deprecated settings:

dracoon_team.updateSystemSettings({
  "body": {
    "items": []
  }
}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token
  • body required ConfigOptionList

Output

Output schema unknown

downloadAvatar

Description:

Download avatar for given user ID and UUID.

Precondition:

Valid UUID.

Postcondition:

Stream is returned.

Further Information:

None.

dracoon_team.downloadAvatar({
  "user_id": 0,
  "uuid": ""
}, context)

Input

• input object
  • user_id required integer: User ID
  • uuid required string: UUID of the avatar

Output

• output string

downloadZipArchiveViaToken

Description:

Download multiple files in a ZIP archive.

Precondition:

Valid download token.

Postcondition:

Stream is returned.

Further Information:

Create a download token with POST /nodes/zip API.

dracoon_team.downloadZipArchiveViaToken({
  "token": ""
}, context)

Input

• input object
  • token required string: Download token

Output

Output schema unknown

downloadFileViaToken

Description:

Download a file.

Precondition:

Valid download token.

Postcondition:

Stream is returned.

Further Information:

Range requests are supported.

dracoon_team.downloadFileViaToken({
  "token": ""
}, context)

Input

• input object
  • token required string: Download token
  • Range string: Range
  • generic_mimetype boolean: Always return application/octet-stream instead of specific mimetype
  • inline boolean: Use Content-Disposition: inline instead of attachment

Output

Output schema unknown

downloadFileViaToken_1

Description:

Download a file.

Precondition:

Valid download token.

Postcondition:

Stream is returned.

Further Information:

Range requests are supported.

dracoon_team.downloadFileViaToken_1({
  "token": ""
}, context)

Input

• input object
  • token required string: Download token
  • Range string: Range
  • generic_mimetype boolean: Always return application/octet-stream instead of specific mimetype
  • inline boolean: Use Content-Disposition: inline instead of attachment

Output

Output schema unknown

requestAuditNodeUserData

Description:

Retrieve a list of all nodes of type room, and the room assignment users with permissions.

Precondition:

Right 🔓 read audit log required.

Postcondition:

List of rooms and their assigned users is returned.

Further Information:

Filtering:

All filter fields are connected via logical conjunction (AND)
Except for userName, userFirstName and userLastName - these are connected via logical disjunction (OR)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE[:VALUE...]

userName:cn:searchString_1|userFirstName:cn:searchString_2|nodeId:eq:2
Filter by user login containing searchString_1 OR first name containing searchString_2 AND node ID equals 2.

Filtering options:

Deprecated filtering options:

Sorting:

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort fields are supported.

nodeName:asc
Sort by nodeName ascending.

Sorting options:

dracoon_team.requestAuditNodeUserData({}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • offset integer: Range offset
  • limit integer: Range limit.
  • filter string: Filter string
  • sort string: Sort string
  • X-Sds-Auth-Token string: Authentication token

Output

• output array
  • items AuditNodeResponse

requestLogEventsAsJson

Description:

Retrieve eventlog (audit log) events.

Precondition:

Role 👤 Log Auditor required.

Postcondition:

List of audit log events is returned.

Further Information:

Output is limited to 500 entries.
For more results please use filter criteria and paging (offset + limit).

Allowed Accept-Header:

• Accept: application/json
• Accept: text/csv

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort fields are supported.

time:desc
Sort by time descending (default sort option).

Sorting options:

dracoon_team.requestLogEventsAsJson({}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • sort string: Sort string
  • offset integer: Range offset
  • limit integer: Range limit.
  • date_start string: Filter events from given date
  • date_end string: Filter events until given date
  • type integer: Operation ID
  • user_id integer: User ID
  • status string (values: 0, 2): Operation status:
  • user_client string: User client
  • X-Sds-Auth-Token string: Authentication token

Output

• output LogEventList

requestLogOperations

Description:

Retrieve eventlog (audit log) operation IDs and the associated log operation description.

Precondition:

Role 👤 Log Auditor required.

Postcondition:

List of available log operations is returned.

Further Information:

None.

dracoon_team.requestLogOperations({}, context)

Input

• input object
  • is_deprecated boolean: Show only deprecated operations
  • X-Sds-Auth-Token string: Authentication token

Output

• output LogOperationList

requestGroups

Description:

Returns a list of user groups.

Precondition:

Right 🔓 read groups required.

Postcondition:

List of user groups is returned.

Further Information:

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE

name:cn:searchString
Filter by group name containing searchString.

Filtering options:

Sorting:

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort fields are supported.

name:asc|expireAt:desc
Sort by name ascending AND by expireAt descending.

Sorting options:

dracoon_team.requestGroups({}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • offset integer: Range offset
  • limit integer: Range limit.
  • filter string: Filter string
  • sort string: Sort string
  • X-Sds-Auth-Token string: Authentication token

Output

• output GroupList

createGroup

Description:

Create a new user group.

Precondition:

Right 🔓 change groups required.

Postcondition:

A new user group is created.

Further Information:

• If a group should NOT expire, leave expireAt empty.
• Group names are limited to 150 characters
• All characters are allowed.

dracoon_team.createGroup({
  "body": {
    "name": ""
  }
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • X-Sds-Auth-Token string: Authentication token
  • body required CreateGroupRequest

Output

• output Group

removeGroup

Description:

Delete a user group.

Precondition:

Right 🔓 delete groups required.

Postcondition:

User group is deleted.

Further Information:

None.

dracoon_team.removeGroup({
  "group_id": 0
}, context)

Input

• input object
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token

Output

Output schema unknown

requestGroup

Description:

Retrieve detailed information about a user group.

Precondition:

Right 🔓 read groups required.

Postcondition:

User group is returned.

Further Information:

None.

dracoon_team.requestGroup({
  "group_id": 0
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token

Output

• output Group

updateGroup

Description:

Update user group's metadata .

Precondition:

Right 🔓 change groups required.

Postcondition:

User group's metadata is changed.

Further Information:

• If a group should NOT expire, leave expireAt empty.
• Group names are limited to 150 characters
• All characters are allowed.

dracoon_team.updateGroup({
  "group_id": 0,
  "body": {}
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token
  • body required UpdateGroupRequest

Output

• output Group

requestLastAdminRoomsGroups

Description:

Retrieve a list of all rooms where the group is defined as last admin group.

Precondition:

Right 🔓 change groups required.

Postcondition:

List of rooms is returned.

Further Information:

An empty list is returned if no rooms were found where the group is defined as last admin group.

dracoon_team.requestLastAdminRoomsGroups({
  "group_id": 0
}, context)

Input

• input object
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token

Output

• output LastAdminGroupRoomList

requestGroupRoles

Description:

Retrieve a list of all roles granted to a group.

Precondition:

Right 🔓 read groups required.

Postcondition:

List of granted roles is returned.

Further Information:

None.

dracoon_team.requestGroupRoles({
  "group_id": 0
}, context)

Input

• input object
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token

Output

• output RoleList

requestGroupRooms

Description:

Retrieves a list of rooms granted to the group and / or that can be granted.

Precondition:

Right 🔓 read groups required.

Postcondition:

List of rooms is returned.

Further Information:

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE

isGranted:eq:false|name:cn:searchString
Get all rooms where the group is NOT granted AND whose name is like searchString.

Filtering options:

dracoon_team.requestGroupRooms({
  "group_id": 0
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • group_id required integer: Group ID
  • offset integer: Range offset
  • limit integer: Range limit.
  • filter string: Filter string
  • X-Sds-Auth-Token string: Authentication token

Output

• output RoomTreeDataList

removeGroupMembers

Description:

Remove group members.

Precondition:

Right 🔓 change groups required.

Postcondition:

Provided users are removed from the user group.

Further Information:

Batch function.
The provided users are removed from the user group.

dracoon_team.removeGroupMembers({
  "group_id": 0,
  "body": {
    "ids": []
  }
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token
  • body required ChangeGroupMembersRequest

Output

• output Group

requestGroupMembers

Description:

Retrieve a list of group member users or / and users who can become a member.

Precondition:

Right 🔓 read groups required.

Postcondition:

List of users is returned.

Further Information:

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE

isMember:eq:false|user:cn:searchString
Get all users that are NOT in this group AND whose (firstName OR lastName OR email OR username) is like searchString.

Filtering options:

Deprecated filtering options:

dracoon_team.requestGroupMembers({
  "group_id": 0
}, context)

Input

• input object
  • group_id required integer: Group ID
  • offset integer: Range offset
  • limit integer: Range limit.
  • filter string: Filter string
  • X-Sds-Auth-Token string: Authentication token

Output

• output GroupUserList

addGroupMembers

Description:

Add members to a group.

Precondition:

Right 🔓 change groups required.

Postcondition:

New members are added to the group.

Further Information:

Batch function.
The newly provided members will be added to the existing ones.

dracoon_team.addGroupMembers({
  "group_id": 0,
  "body": {
    "ids": []
  }
}, context)

Input

• input object
  • X-Sds-Date-Format string (values: UTC, LOCAL, OFFSET, EPOCH, LEET): Date time format (cf. RFC 3339 & leettime.de)
  • group_id required integer: Group ID
  • X-Sds-Auth-Token string: Authentication token
  • body required ChangeGroupMembersRequest

Output

• output Group

removeNodes

Description:

Delete nodes (room, folder or file).

Precondition:

Authenticated user with 🔓 delete permissions on supplied nodes (for folders or files) or on superordinated node (for rooms).

Postcondition:

Nodes are deleted.

Further Information:

Nodes MUST be in same parent.

dracoon_team.removeNodes({
  "body": {
    "nodeIds": []
  }
}, context)

Input

• input object
  • X-Sds-Auth-Token string: Authentication token
  • body required DeleteNodesRequest

Output

Output schema unknown

requestNodes

Description:

Provides a hierarchical list of file system nodes (rooms, folders or files) of a given parent that are accessible by the current user.

Precondition:

Authenticated user.

Postcondition:

List of nodes is returned.

Further Information:

EncryptionInfo is NOT provided.

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE[:VALUE...]

type:eq:room:folder|perm:eq:read
Get nodes where type equals (room OR folder) AND user has read permissions.

Filtering options:

Sorting:

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort fields are NOT supported.
Nodes are sorted by type first, then by sent sort string.

name:desc
Sort by name descending.

Sorting options:

| `timestam