Introduction

This document describes Synkzone SSI - the Synkzone REST API.

Synkzone is a secure storage and collaboration service for professional organizations. All organizations have their own private clouds where they easily can organize information and securely store, share and collaborate. The service can normally be accessed by different clients such as synchronizing desktop clients, web clients and the Synkzone REST API, called Synkzone SSI.

Before the actual API is described some Synkzone entities are briefly described here.

Organizations Each customer have a single Synkzone organization delivered as a private cloud. Either through standard deployment (using default hosted service by Synkzone) or delivered as an on-prem solution or even as an isolated solution (called Synkzone world). It is possible to deploy an organization with a customer specific deployment and customer specific settings. The organizations settings can be retrieved and modfied by an administrator in the organisation.

Zones In Synkzone all information and collaboration is divided into zones. Zones are private isolated compartments where a file/folder structure, zonelog and chat messages are shared and accessible by its members. Every zone has a folder root where the file directory exists. The zones also have a zone log which contains automatic generated log messages with information about zone events such as modification/addition/deletion of files. A user can be granted access to one or more zones, this is done by the zone manager.

Files and Folders In a zone a directory structure may exist. A File in Synkzone consists of a list of one or more immutable fileversions. Every time a file is modified a new file version is added to that file. Files can be deleted and later restored. Files can also be permanently removed (special permissions are required).

Users Most operations in the system requires an authorized user. The user has to be authenticated and have a session to interact with the system.

REST API

This document describes the REST API for the Synkzone service. It allows you to create applications interacting with the Synkzone service and perform actions like uploading and reading files belonging to your zones.

REST stands for ‘Representational State Transfer’. When people user the term ‘REST API’ they are generally referring to using the HTTP protocol against a set of URLs in order to access a number of resources. Every URL represents a resource like a ‘user’, ‘file’ or ‘zone’. The verbs that are defined in the HTTP protocol defines what one would want to do with said resource. The verbs that can be used in this API are:

• GET
• PUT
• POST
• DELETE

GET is used when one wants to read one or more records of a given resource, POST is used to create a new record of the resource, PUT is to update an existing record of a resource and DELETE is to, yes, delete an existing record of a resource.

In this document we will use the terms resource and endpoint to refer to a url for a specific resource.

From a birds-eye view the endpoints within the API are divided into sections:

• Access - deals with login/logout functionality.
• Files and multipart upload - deals with uploading, downloading, listing and deletion of folders and files.
• OAuth2 - deals with operations to support OAuth2.
• Organization - deals with settings of the organization.
• Platform notifications - deals with notifications from platform to user.
• Share - deals with sharing resources with others outside the organization or zone.
• Support - deals with creating support requests.
• Token management - deals with operations to support management of tokens.
• Users - deals with operations relating to users.
• Zones - deals with any operation regarding zones.
• Zone log - deals with events and messages (the zone log) within a zone.

We will here go though some concepts regarding this API, then a getting started section and at last go though the API itself. If you feel adventurous and want to jump straight into connecting to the API feel free to jump to the Getting Started section.

Authentication

Authentication request

POST /api/access/logon HTTP/1.1
Content-Type: application/json
Accept: */*
Host: <host>
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 177

{
  "password": [
    "p", "a", "s", "s", "w", "o", "r", "d"
  ],
  "setCookie": true,
  "timeout": 3600000,
  "username": "<username@synkzone.test>"
  }

Authentication response

HTTP/1.1 200 OK
Set-Cookie: Synkzone=-135610627654801378;Version=1;Path=/;Max-Age=86400000;HttpOnly
Content-Length: 76
Content-Type: application/json

{"expiresInMillis":3599999,"logonOK":true,"sessionID":"-135610627609090378"}

Authentication token request

POST /api/zones/<zoneid>/files/<folderid> HTTP/1.1
Authorization: Bearer -135610627609090378
Content-Type: application/octet-stream
Accept: */*
Host: <host>
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 1521

Before any endpoints can be called the client needs to be authenticated. This is done by calling the either i) an issued bearer token or ii) using the logon endpoint with the credentials provided to you by Synkzone. Please note that the password needs to be sent as an array of chars rather than as a string due to security reasons.

Your credentials keys carry many privileges, so be sure to keep them secure! Do not share your credentials in publicly accessible areas such as GitHub, client-side code, and so forth.

If the logon message was used and the request was successful then the response from the endpoint will contain a session id which can be used as a bearer token and if requested a cookie will be set containing the very same bearer token. It will also contain an expiration time period in milliseconds. It is the responsibility of the calling application to keep track of token lifespan and create a new token if necessary.

Authentication against the other endpoints can then be done by either providing said cookie or by adding the given bearer token to a Authorization header. Please see example to the right. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Bearer tokens

As an alternative to creating a short lived sessionID through the logon method, it is possible to create bearer tokens that can be used towards the API. These are created by calling the API endpoint to create a token. The tokens created can have a name, a validity and possibly a tailored scope for the purpose.

The endpoint to create or manage tokens is /api/tokens.

Oauth2

The Synkzone service supports the OAuth2 flow. More details and full implementation TBA.

Requests

In general all request are done as a HTTPS request and any data sent to the server will be as JSON, Content-Type must be set to application/json. There as a few exceptions to this, for example file upload, which can either be done as application/octet-stream or as a multipart/form-data.

Responses

In general, all responses are as JSON and uses the application/json. Against there are exceptions to this for the endpoint that returns actual file content, this endpoint returns application/octet-stream. All dates and times in any response are written as ISO 8601 and is using UTC. Every response will contain a HTTP status code, showing if the request was processed successfully or not.

The following HTTP statues are available:

• 200 OK - Request was successful
• 201 Created - The resource was successfully created (after a POST call)
• 400 Bad request - The request contained an error
• 401 Unauthorized - The user is not logged in/no user credentials provided
• 403 Forbidden - User credentials are provided but user has not enough rights
• 404 Not found - The endpoint or resource does not exist
• 409 Conflict - Resource already exists
• 500 Internal Server Error - Unspecified server error
• 503 Service unavailable - The API is not reachable at the moment

In addition to the above HTTP status codes the responses will also contain the actual response body, which will hold the data request in JSON format, or, if the response is an error, an error structure describing the error.

{"message":"Error description"}

Pagination

Some calls are paginated. Pagination (sometimes called paging) is controlled by parameters page (default 1) and pageSize (default 100). Whenever a call results in more items then pageSize, further requests using page is needed to retrieve all entries.

Scope

The scope concept is a powerful tool to limit or restrict a session (logon) or the capabilities of an issued bearer token. As a general rule bearer tokens are connected to a user in the system and thus cannot have any capabilities beyond what that user has. Scopes can further restrict these issued rights. More on scope TBA.

Getting started

In this tutorial we will go through some common steps with regards to this API.
We will:

1. Authenticate against the Synkzone service
2. List all available zones for the logged in user
3. List root directory in one of the zones
4. Retrieve file metadata for a file
5. Download content of a file
6. Upload a file

Prerequisites

There are some things we need before we get going.

1. The credentials for a user that is a member of at least one zone - credentials are provided by the Synkzone service when the user account is created. The credentials used are organization specific and can for example be a password and possibly an additional MFA (Multi Factor Authentication) such as TOTP (Time-based one-time password).
2. A tool like Postman or curl in order to call the Synkzone REST API. The examples in this tutorial will use curl.
3. An existing zone containing some files and folders.

API request anatomy

Your API request will consist of the following items:

1. API URL. Your API is accessed at: https://<organisation-name>.synkzone.com/api. The path part will depend on the endpoint you are trying to call.
2. Authorization header. This allows you to authenticate against the endpoint. Without authentication you will not be able to make any successful calls.
3. Payload or request parameters (optional). When submitting a POST or PUT request, as for creating or updating a resource, you need to provide the new or updated info to the endpoint which is done as a payload written in JSON. For some GET requests the request can be refined by adding query parameters as a segment of the path.

Now let’s try out our first request.

Authentication

Authentication request

curl --location --request POST http://<your-organization-name>.synkzone.com/api/access/logon \
--header 'Content-Type: application/json' \
--data-raw '{
  "password": [
    "p", "a", "s", "s", "w", "o", "r", "d"
  ],
  "username": "<username@synkzone.com>",
  "verificationCode": "<TOTP>"
  }'

Authentication response

{"expiresInMillis":3600000,"logonOK":true,"sessionID":"3881603599579212345"}

The first thing we will need to do before calling any API endpoints is to authenticate ourselves. This is done by calling the /api/access/logon endpoint as seen to the right. Please note that you need to change the password and the username to your credentials which you should have received from Synkzone. If your organization uses MFA, use the verificationCode field - otherwise remove it. All other parameters can stay as they are.

If all goes well you will now receive some JSON back from the Synkzone service stating that your login attempt was successful. If not, please double check your input in the request. Please note that the request may also result in that more credentials (such as for example a TOTP) are needed to successfully logon. The successful JSON response will contain a sessionID property. This property is your token to use for authentication in any subsequent calls to the API.

Create authentication token

Create token request

curl --location --request POST http://<your-organization-name>.synkzone.com/api/tokens \ 
--header 'Authorization: 3881603599579212345' \
--data-raw '{
  "tokenName": "An example token",
  "validity": 262980000,
  "password": [
    "p", "a", "s", "s", "w", "o", "r", "d"
  ]
}'

Create token response

{
    "expiry": 986994936,
    "id": "185b3dd0-b725-4b2a-8292-f3cfe5251d19",
    "token": "P-7C4F101CF8725ED27D285E6C68FE47C608303455F2F4FEEBA4675B1401AED030-"
}

If you prefer you can use tokens as authentication method instead of using login and session id. To create a token you need to provide the password, since this is embedded in your token. Using the example request a token containing the same access levels as the user will be created, i.e. everything that user can view and create/modify can be done by that token. Validity is given in seconds.

The response of a successfully created token contains the token, the id of the token and its expiry (in milliseconds). This is the only time the token will be visible, do make sure to store it in a safe way. An expired token will not be automatically deleted and can be viewed in the list of all tokens. The generated token can now be used instead of a session id as authentication method. All tokens can be viewed by a GET request to the /api/tokens endpoint.

The rest of the examples in this “Getting started” guide will use session id as authorization.

List available zones

List available zones request

curl --location --request GET http://<your-organization-name>.synkzone.com/api/zones \
--header 'Authorization: 3881603599579212345'

List available zones response

[
  {
    "allowExternalSharing": false,
    "createdAt": "2022-04-07T12:20:38.673+02:00",
    "createdBy": "bob.tyler@organization.org",
    "currentSize": -1,
    "description": "A zone for testing",
    "id": "9391ee2e-b554-4bb5-8888-c3d7d6f0daa7",
    "name": "TestZone1",
    "numberOfUsers": 1,
    "rootId": "9E54F56ABE43411FAB6FE4852D5E64F9038A52FC0000018016E39605706B7F8F",
    "ssiAccessible": true,
    "type": "8ce19e4e-cecb-4c53-bd62-9113a2d0af8b",
    "typeName": "Private",
    "useECM": false,
    "webAccessible": true
  }
]

Now we want to check which zones we have access to. Take the sessionID value you received in the previous call (or a created bearer token) and add it as a Bearer token in an Authorization header to the following call.

A successful response will give you a JSON list of one or more zone objects. These zone objects will contain the id of the zone as well as the id of the root folder in the zone. using these two ids we can list the content of the root folder of a given zone.

List root directory of zone

List root directory request

curl --location --request GET http://<your-organization-name>.synkzone.com/api/zones/9391ee2e-b554-4bb5-8888-c3d7d6f0daa7/folder/9E54F56ABE43411FAB6FE4852D5E64F9038A52FC0000018016E39605706B7F8F \
--header 'Authorization: 3881603599579212345' 

List root directory response

[
 {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "deleted": false,
    "displayName": "test (2).txt",
    "folder": false,
    "id": "B2E00D1E20E645A083FE6238932AC5FC7B9E7B410000018116F834621B3EB854",
    "lastModified": "2022-06-13T16:27:39.019+02:00",
    "lastModifiedBy": "josef.smith@organization.org",
    "name": "test (2).txt",
    "parentId": "FE612674501748208CCB6AB2974E6DEDFD9463BF0000017F16E33B116FE72F10",
    "properName": "test (2)",
    "size": 4,
    "synchronizationStatus": "NotSynchronizing",
    "type": "TXT",
    "zoneId": "98762633-0b3d-40c8-8089-31d39c27a0fe"
  }
]

Let’s list the root folder of a zone. Take the zone id and the root folder id of a zone listed in previous response and replace the dummy values in the example call below. If possible please pick a zone that you know contains at least a single file, ideally more, and see what it contains. We will use the same sessionID as we did in the previous call.

In the response we can see a JSON list of entries again. This time each entry in the list represents a file or a folder. You can see what each item is by looking at the folder property, if true then the object is a folder, if false then it is a file.

Retrieve file metadata for a file

Get file metadata request

curl --location --request GET http://<your-organization-name>.synkzone.com/api/zones/9391ee2e-b554-4bb5-8888-c3d7d6f0daa7/files/B2E00D1E20E645A083FE6238932AC5FC7B9E7B410000018116F834621B3EB854 \
--header 'Authorization: 3881603599579212345' 

Get file metadata response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "test (2).txt",
  "folder": false,
  "id": "B2E00D1E20E645A083FE6238932AC5FC7B9E7B410000018116F834621B3EB854",
  "lastModified": "2022-06-13T16:27:39.019+02:00",
  "lastModifiedBy": "josef.smith@organization.org",
  "name": "test (2).txt",
  "parentId": "FE612674501748208CCB6AB2974E6DEDFD9463BF0000017F16E33B116FE72F10",
  "properName": "test (2)",
  "size": 4,
  "synchronizationStatus": "NotSynchronizing",
  "type": "TXT",
  "zoneId": "98762633-0b3d-40c8-8089-31d39c27a0fe"
}

Take an entry from the above response that has the folder property set to false, this means the item represents a file. Lets see what meta data we can find for it. Meta data is data that describes the file/folder, but not the actual content of the file or folder. Info like file name, file size, create data, modify date and owner are examples of meta data.

The call will come back with a JSON structure listing various properties of the file itself, like size, last modified, owner, etc. The only thing missing is the actual file content itself. We will get that in the next call.

Download content of a file

Download file request

curl --location --request GET http://<your-organization-name>.synkzone.com/api/zones/9391ee2e-b554-4bb5-8888-c3d7d6f0daa7/files/dad3a6697ed64324ae57a1cf6bf12920acbb4b490000017d16123123cd9019/content \
--header 'Authorization: 3881603599579212345'  \
-o file.txt

Download file response

<OCTET STREAM>

Do the same call as before but add content to the end of the url. this will result in the content of the file itself being returned as an octet stream. We are here assuming the file you are downloading is a .txt file. If it is not please adjust accordingly.

You should now be able to open the file.txt file and view the downloaded content.

Upload a file

Upload file request

curl --location --request POST http://<your-organization-name>.synkzone.com/api/zones/9391ee2e-b554-4bb5-8888-c3d7d6f0daa7/files/9B6F3394137E43498464CCF7A18079E5DFE876750000017F16E17650E268A2E4 \
--header 'Authorization: 3881603599579212345' \
--form file=@testfile.txt \
--form fileName="testfile.txt"

Upload response

{
  "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
  },
  "deleted": false,
  "displayName": "testfile.txt",
  "folder": false,
  "id": "52CF0A9FCFBB41A2917D9CB51B05A33BEF301FB4000001831716953C65ACF705",
  "lastModified": "2022-09-20T15:39:58.975+02:00",
  "lastModifiedBy": "josef.smith@organization.org",
  "name": "testfile.txt",
  "parentId": "9B6F3394137E43498464CCF7A18079E5DFE876750000017F16E17650E268A2E4",
  "properName": "testfile",
  "size": 137,
  "synchronizationStatus": "NotSynchronizing",
  "type": "TXT",
  "zoneId": "9391ee2e-b554-4bb5-8888-c3d7d6f0daa7"
}

After downloading a file we might want to try to upload another. This call uploads a file as multipart/form-data. When using this request don’t forget to update the path to your file specified in the --form parameter. You will need to provide a name for the uploaded file by setting the string parameter fileName.

If the file upload was successful you should see the metadata of the file as a response.

Groups

What is a group?

A group is a collection of users in an organization. Groups can be added as members of a zone, granting them access rights similar to those of individual users. Groups provide an efficient way to organize users within an organization. A group consists of one or more managers and as many members as desired. If needed, a group can also be a member of another group.

As an administrator you will be able to manage groups. Each group has at least one manager responsible for handling the members of the group.

Create a group

To create a group provide the endpoint /api/groups with name, description and group members.

Create new group

curl --location --request POST http://<your-organization-name>.synkzone.com/api/groups  
--header 'Authorization: 3881603599579212345' 
--data-raw '{
    "members": [
        {"accessLevel": "Manage", "memberId": "helen@organization.com"}, 
        {"accessLevel": "Access", "memberId": "bob@organization.com"},
        {"accessLevel": "Access", "memberId": "joe@organization.com"},
    ], 
    "name": "Sales", 
    "description": "Everyone working at the sales department"
    }'

Create new group response

{
  "members": [
    {
      "accessLevel": "Manage",
      "authorization": "Administrator",
      "displayName": "Helen",
      "memberId": "helen@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Access",
      "authorization": "Internal",
      "displayName": "Bob",
      "memberId": "bob@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Access",
      "authorization": "Administrator",
      "displayName": "Joe",
      "memberId": "joe@organization.com",
      "memberType": "User"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T11:56:10.493+02:00",
    "createdBy": "helen@organization.com",
    "description": "Everyone working at the sales department",
    "groupId": "group.451d5g41-44y7-4978-8c25-d3e12cceuy6d@organization.com",
    "name": "Sales",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

It’s possible to add a group as a member in another group. To do that, add the group id instead of the user id when adding members to the group. See example “Create group with group as member”.

Create group with group as member

curl --location --request POST http://<your-organization-name>.synkzone.com/api/groups  
--header 'Authorization: 3881603599579212345' 
--data-raw '{
    "members": [
        {"accessLevel": "Manage", "memberId": "joe@organization.com"}, 
        {"accessLevel": "Access", "memberId": "group.ba4ca7b0-1bb5-4303-9d05-72586b86a9e1@organization.com"}
    ], 
    "name": "Groupmania", 
    "description": "A group with a group as member"
    }'

Create group with group as member response

{
  "members": [
    {
      "accessLevel": "Access",
      "memberType": "Group",
      "displayName": "Summer interns",
      "memberId": "group.ba4ca7b0-1bb5-4303-9d05-72586b86a9e1@organization.com"
    },
    {
      "accessLevel": "Manage",
      "authorization": "Administrator"
      "memberType": "User",
      "displayName": "Joe",
      "memberId": "joe@organization.com"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T16:03:53.701+02:00",
    "createdBy": "joe@organization.com",
    "description": "Summer interns of 2024",
    "groupId": "group.a49d73f7-80ea-4a56-9711-057e362f7cfe@organization.com",
    "name": "Sales",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

Manage groups

When making changes to the member list of an existing group, the provided member list in the request body can either be applied as changes to the current access rights of the group or as a replacement to the current access rights. This is specified by the flag “relative”, a boolean added as a query parameter. The default is to apply the given members list as changes to the current access rights of the group, having relative=true.

Let’s say the starting point is a group with Bob as manager and Joe as a member in it. If updating using the default value of “relative” (true), where Joe should be manager and Helen a member the request should be as in example “Update access rights in group”.

Update access rights in group

curl --location --request PUT http://<your-organization-name>.synkzone.com/api/groups/group.ed5548f1-6681-40a9-a11e-80232b7be4f6@organization.com
--header 'Authorization: 3881603599579212345' 
--data-raw '{
    "members": [
        {"accessLevel": "Manage", "memberId": "joe@organization.com"}, 
        {"accessLevel": "Access", "memberId": "helen@organization.com"}
    ]
    }'

The result of this will be a group with Bob and Joe as managers, and Helen as a member, see “Update access rights in group response”.

Update access rights in group response

{
  "members": [
    {
      "accessLevel": "Access",
      "authorization": "Administrator",
      "displayName": "Helen",
      "memberId": "helen@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Manage",
      "authorization": "Internal",
      "displayName": "Bob",
      "memberId": "bob@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Manage",
      "authorization": "Administrator",
      "displayName": "Joe",
      "memberId": "joe@organization.com",
      "memberType": "User"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T07:22:10.313+02:00",
    "createdBy": "bob@organization.com",
    "description": "Sales management team",
    "groupId": "group.ed5548f1-6681-40a9-a11e-80232b7be4f6@organization.com",
    "name": "Sales management",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

If updating and setting “relative” to false, the current access rights of the group is replaced. If the starting point is the same (Bob as manager and Joe as a member) and the request is as stated in “Replace access rights in group” the result of the request will be that only Joe is left in the group, and has changed access righs to being the manager for the group.

Replace access rights in group

curl --location --request PUT http://<your-organization-name>.synkzone.com/api/groups/group.1c4f5180-a008-4bf0-828c-fdd11cdc60dd@organization.com?relative=false
--header 'Authorization: 3881603599579212345' 
--data-raw '{
    "members": [
        {"accessLevel": "Manage", "memberId": "joe@organization.com"}
    ]
    }'

Replace access rights in group response

{
  "members": [
    {
      "accessLevel": "Access",
      "authorization": "Administrator",
      "displayName": "Helen",
      "memberId": "helen@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Manage",
      "authorization": "Internal",
      "displayName": "Bob",
      "memberId": "bob@organization.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Manage",
      "authorization": "Administrator",
      "displayName": "Joe",
      "memberId": "joe@organization.com",
      "memberType": "User"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T07:22:10.313+02:00",
    "createdBy": "bob@organization.com",
    "description": "Sales management team",
    "groupId": "group.ed5548f1-6681-40a9-a11e-80232b7be4f6@organization.com",
    "name": "Sales management",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

It’s possible to make updates to the access rights of an individual member at a time using the endpoint /api/groups/{groupid}/members/{memberid}.

Update individual access rights in group

curl --location --request PUT http://<your-organization-name>.synkzone.com/api/groups/group.ed5548f1-6681-40a9-a11e-80232b7be4f6@organization.com/members/joe@organization.com?accesslevel=Manage
--header 'Authorization: 3881603599579212345' 

To remove a member of the group, set the group member access right to ‘None’.

Delete groups

A group is deleted by a delete request to /api/groups/{groupid}.

Delete group

curl --location --request DELETE http://<your-organization-name>.synkzone.com/api/groups/group.ed5548f1-6681-40a9-a11e-80232b7be4f6@organization.com/
--header 'Authorization: 3881603599579212345' 

When a group is deleted all it’s members will lose the zone access that was given by the group being a zone member.

Group properties

All groups are currently configured to be open, meaning a user in the system will be able to view which of its coworkers that are members of a group.

Groups as zone members

When giving a group access rights to a zone, making it a zone member, all members of the group will get access to the zone and its content just as if they were added individually. A group can have any access level in a zone except being a zone manager. If access rights to a zone are provided by multiple group memberships, the highest access level will be used. If an explicit access level is set for a user in a zone, that explicit level will take precedence over all other access levels provided by group memberships (excluding None level which is not applicable). E.g. the user is individually added to the zone with ‘Add’ rights and the group is added with ‘Modify’ rights, then the resulting access right for that user will be ‘Add’. If the group is removed as a zone member, the user will still have the individual access right to the zone.

SSI Rest API v4.55.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Email: SSI Rest API Support Web: SSI Rest API Support License: Proprietary

Authentication

• HTTP Authentication, scheme: basic Deprecated Authorization in the form of Basic base64Encoded(user:password), where user:password is your username and password concatenated with a colon and then Base64-encoded. For ProtectionType PASSWORD user can be anything or empty example = Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

• HTTP Authentication, scheme: bearer Preferred authentication using Bearer token in Authorization header. Use endpoint /share/{sharekey}/tokento retrieve a short lived token that can be used.

• API Key (cookieAuth)
  • Parameter Name: auth_token, in: cookie. Session cookie used as alternative authentication.

Access

All operations related to sign on and sign off.

Get AuthorizationRequirements

Code samples

# You can also use wget
curl -X GET /api/access/authorizationrequirements \
  -H 'Accept: application/json'

GET /api/access/authorizationrequirements

Gets the AuthorizationRequirements so that the right logon information can be produced.

Example responses

200 Response

{
  "canSavePassword": false,
  "idpName": "",
  "idpRequired": false,
  "organizationName": "greattools.org",
  "otpRequired": false,
  "otpType": "None",
  "passwordRequired": true,
  "worldName": "Synkzone"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AuthorizationRequirements]	false	none	none
» passwordRequired	boolean	false	none	Specifies if a password is always required, or only required sometimes.
» canSavePassword	boolean	false	none	Specifies if saving the password may be specified by the user.
» otpRequired	boolean	false	none	Specifies if a one-time-password (OTP) is always required.
» otpType	OTPType	false	none	Specifies the type of OTP that is required.
» organizationName	string	false	none	The name of the organization that this instance belongs to.
» worldName	string	false	none	The name of the world that this instance belongs to (normally Synkzone).
» idpData	[IDPData]	false	none	A list of supported IDP (Identity Providers) that can be used to logon the user. If no IDPS are available the field will not be present.
»» name	string	false	none	IDP Name.
»» description	string	false	none	A description of the IDP.
» personalIdentificationTypes	[PersonalIdentificationTypeData]	false	none	A list of supported personalIdentificationTypes.
»» name	string	false	none	The name of the Personal Identification Type
»» description	string	false	none	A description of the Personal Identification Type
»» icon	string(binary)	false	none	An icon that represents the Personal Identification Type

Enumerated Values

Property	Value
otpType	None
otpType	TOTP
otpType	HOTP
otpType	SynkzoneMail

Get IDPSignOnURI

Code samples

# You can also use wget
curl -X GET /api/access/idpsignonuri?fragmentResponse=false&idpName=&organization=&redirectURI= \
  -H 'Accept: application/json'

GET /api/access/idpsignonuri

Get a URI for making an OAuth 2.x or OIDC authorization request to the IDP configured for the specified organization. The response from this URI (received at the specified redirectURI) can later be used as authorization token provided by the user controller in a call to the signOn method.

Parameters

Name	In	Type	Required	Description
fragmentResponse	query	boolean	true	Specifies if the response to the redirectURI must be in fragment form (otherwise the response will be a POST with contents as a form.
idpName	query	string	true	Name of the IDP to use.
organization	query	string	true	The name of the organization that the user want to sign on to.
redirectURI	query	string	true	The URI at which the client will listen for responses to the authorization request.

Example responses

200 Response

{
  "uri": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline

Response Schema

Status Code 200

The URI for making an OAuth 2.x or OIDC authorization request to the IDP configured for the specified organization. The response from this URI (received at the specified redirectURI) can later be used as authorization token provided by the user controller in a call to the signOn method.

Name	Type	Required	Restrictions	Description
» uri	string	false	none	none

Log off from platform

Code samples

# You can also use wget
curl -X GET /api/access/logoff \
  -H 'Accept: application/json'

GET /api/access/logoff

Logs user off form Synkzone platform. Also expires session cookie if such exists.

Example responses

404 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Log on to platform

Code samples

# You can also use wget
curl -X POST /api/access/logon \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

POST /api/access/logon

Logs user on to Synkzone platform returning a sessionID (if requested sets a session cookie).

Body parameter

{
  "username": "bob@happyday.com",
  "password": [
    "a",
    "b",
    "c",
    "1"
  ],
  "passwordAsString": "password123",
  "verificationCode": "177600",
  "setCookie": true,
  "sameSitePolicy": "Strict",
  "scope": "\"User=bob@example.com\":{\"get\":true}",
  "timeout": 600000,
  "timeoutInSeconds": 600,
  "acceptSessions": false,
  "logonSessionId": "1679664938247",
  "token": "",
  "savePassword": false,
  "organizationName": "happyorg.com",
  "autoLogon": true
}

Parameters

Name	In	Type	Required	Description
X-Real-Ip	header	string	false	none
body	body	LogonRequest	false	none

Example responses

200 Response

{
  "expiresInMillis": 599998,
  "logonOK": true,
  "passwordChangeIsRequired": false,
  "sessionId": "fd4c61ef4e1db659b7be7ad3cc6ca60e07077b1cb94f386d4bf0149747f6892f"
}

202 Response

{
  "state": "PASSWORDPENDING",
  "sessionId": "fd4c61ef4e1db659b7be7ad3cc6ca60e07077b1cb94f386d4bf0149747f6892f",
  "userId": {
    "name": "joe.smith@example.com"
  }
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Invalid user"
}

401 Response

{
  "error": "AUTHORIZATION_FAILED",
  "message": "Authorization failed"
}

403 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully. If indata contains setCookie=true a cookie containing the sessionId will be set. Note: Please check field passwordChangeIsRequired, if true the user is forced to change the password before all the REST endpoints can be used.	Inline
202	Accepted	Accepted. Note: This response will only be used when the user has accepted session based logon flows by setting the acceptSessions=true. Additional credentials must be provided. This response is used to request the user to supply additional credentials to an existing logon session. Check state field in response to see if a required field was missing in case of multi step authentication, e.g. a missing password or verificationCode, see LogonSessionState. Provide the missing credential and the sessionId in a new LogonRequest to continue the logon request or send empty credentials to cancel the request.	Inline
400	Bad Request	Bad Request. APIErrors: ILLEGAL_ARGUMENT, INVALID_DATA,

 *         INVALID_SESSIONID</code>|Inline|

|401|Unauthorized|Unauthorized. The request failed. If the user sent acceptSessions=true this flow has terminated permanently and cannot be continued. APIErrors: TEMPORARY_BLOCKED, PASSWORD_FAILURE, * VERIFICATIONCODE_FAILURE, AUTHORIZATION_FAILED.
Note that normally AUTHORIZATION_FAILED will be returned for user unknown or wrong password. PASSWORD_FAILURE and VERIFICATIONCODE_FAILURE will be returned within a logon flow.|Inline| |403|Forbidden|Forbidden. APIErrors: NOT_ALLOWED, ALREADY_LOGGED_ON, UNSUPPORTED_VERSION|Inline| |408|Request Timeout|Request Timeout. APIErrors: FAILED|Inline| |500|Internal Server Error|Internal Server Error. APIErrors: FAILED, LOAD_ERROR|Inline| |502|Bad Gateway|Bad Gateway. APIErrors: COMMUNICATION_ERROR|Inline| |503|Service Unavailable|Service Unavailable. APIErrors: NOT_AVAILABLE|Inline|

Response Schema

Status Code 200

Returned as a response to a successfull LogonRequest.

Name	Type	Required	Restrictions	Description
» logonOK	boolean	true	none	True if logon was successfull. Please check field passwordChangeIsRequired to determine if the password needs to be changed.
» sessionId	string	false	none	The sessionId, which can be used as authentication for further calls. It is set in a cookie if setCookie=true was set in the LogonRequest. Provide the cookie in further calls or use the Authorization HTTP header like this Authorization: Bearer sessionId
» expiresInMillis	integer(int64)	false	none	The sessionId timeout in milliseconds. If you do not want to actively keep the session alive you should set a large enough expiry.
» idpURI	string(uri)	false	none	Request that an IDP URI is opened in a web browser to allow the user to authenticate and authorize with an IDP.
» passwordChangeIsRequired	boolean	false	none	If true the user is required to change password immediately and no other operations are allowed before this is done. IMPORTANT NOTE only ‘change password’ endpoint is reachable in this case!
» userId	UserId	false	none	The userId related to the result.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.

Status Code 202

This message is returned when ‘session-based-logon-flows’ are used. It is used to describe what credentials that needs to be provided in order to continue a logon flow. To use ‘session-based-logon-flows’ set acceptSessions=true in LogonRequest message.

Name	Type	Required	Restrictions	Description
» state	State	false	none	The current state. Describes what credentials that needs to be provided
» sessionId	string	false	none	The sessionId, which can be used to continue a session in further calls. Send this sessionId in the logonSessionId field in the LogonRequest message.
» userId	UserId	false	none	The userId related to the result.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.

Enumerated Values

Property	Value
state	PASSWORDPENDING
state	VERIFICATIONCODEPENDING

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 502

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 503

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Response Headers

Status	Header	Type	Format	Description
200	Set-Cookie	string		Session cookie containing the sessionId.

Request New Credentials

Code samples

# You can also use wget
curl -X POST /api/access/newcredentials \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

POST /api/access/newcredentials

Request that the specified user account is assigned new credentials. A text will be returned with confirmation that a request has been sent, or with instructions for how to request new credentials.

Body parameter

{
  "name": "bob@example.com"
}

Parameters

Name	In	Type	Required	Description
X-Real-Ip	header	string	false	none
body	body	UserId	false	none

Example responses

200 Response

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

A class used when a user looses his password and wants to request a new one.

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get personal-identity signOn URI

Code samples

# You can also use wget
curl -X GET /api/access/personalid-signonuri?authentication%2Dtype=SWEDISH_MOBILE_BANK_ID&organization=&redirectURI= \
  -H 'Accept: application/json'

GET /api/access/personalid-signonuri

Get a URI for making a sign on authorization request using a personalIdentity. The response from this URI (received at the specified redirectURI) can later be used as authorization token provided by the user controller in a call to the signOn method.

Parameters

Name	In	Type	Required	Description
authentication-type	query	string	true	Name of the authentication type to use.
organization	query	string	true	The name of the organization that the user want to sign on to.
redirectURI	query	string	true	The URI at which the client will listen for responses to the authorization request.

Example responses

200 Response

{
  "uri": "https://login.grandid.com/?sessionid=7888e6f5157d693c57ce27babd292201"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline

Response Schema

Status Code 200

The URI for making an OAuth 2.x or OIDC authorization request to the IDP configured for the specified organization. The response from this URI (received at the specified redirectURI) can later be used as authorization token provided by the user controller in a call to the signOn method.

Name	Type	Required	Restrictions	Description
» uri	string	false	none	none

Revalidate

Code samples

# You can also use wget
curl -X GET /api/access/revalidate \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

GET /api/access/revalidate

Provide information about revalidation timers and required field. Revalidation is used for certain operations (e.g. read protected files) when service is ran as Web backend.

Parameters

Name	In	Type	Required	Description
X-Real-Ip	header	string	false	none

Example responses

200 Response

{
  "passwordDuration": 0,
  "verificationCodeDuration": 0,
  "revalidateTimeout": 0,
  "expectedField": "password"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» passwordDuration	integer(int64)	false	none	The number of milliseconds before a password revalidate expires.
» verificationCodeDuration	integer(int64)	false	none	The number of milliseconds before a verification code revalidate expires.
» revalidateTimeout	integer(int64)	false	none	The default expiry timeout for revalidation.
» expectedField	RevalidateNeededField	true	none	The expected field to be supplied for revalidation.

Enumerated Values

Property	Value
expectedField	unknown
expectedField	password
expectedField	verificationCode
expectedField	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Revalidate Authentication

Code samples

# You can also use wget
curl -X POST /api/access/revalidate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

POST /api/access/revalidate

Provide credentials (for a limited time) so that methods that require recent revalidation can use these (e.g. read protected files).

Body parameter

{
  "password": [
    "a",
    "b",
    "c"
  ],
  "verificationCode": "123700"
}

Parameters

Name	In	Type	Required	Description
X-Real-Ip	header	string	false	none
body	body	Credentials	false	none

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Request executed successfully	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Files

All operations related to files and folders.

find ZoneFileDataDto based on path

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/find \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/zones/{zoneid}/files/find

Find a ZoneFileData based on a specific path.

Body parameter

{
  "path": "/folder22/hello.txt"
}

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	The identity of the zone to use.
body	body	Path	false	none

Example responses

200 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "availableActions": {
    "archive": false,
    "browse": false,
    "copy": false,
    "copyPath": true,
    "cut": false,
    "delete": true,
    "download": false,
    "downloadAuthenticationTimeout": 9223372036854776000,
    "exclude": true,
    "include": false,
    "lock": true,
    "newFolder": true,
    "open": false,
    "openConflict": false,
    "paste": false,
    "permanentDelete": true,
    "readEnable": false,
    "readProtect": true,
    "removeConflict": false,
    "rename": true,
    "restore": false,
    "showConflict": false,
    "showLog": true,
    "unlock": false,
    "upload": false,
    "useConflicting": false,
    "webLink": false,
    "writeEnable": false,
    "writeProtect": true
  },
  "deleted": false,
  "displayName": "findings.txt",
  "firstChanged": 1689060990207,
  "folder": false,
  "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
  "lastChanged": 1689061017879,
  "lastModified": "2023-07-11T09:36:53.273+02:00",
  "lastModifiedBy": "hans@greattools.net",
  "name": "findings.txt",
  "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
  "properName": "findings",
  "size": 48,
  "synchronizationStatus": "NotSynchronizing",
  "type": "TXT",
  "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600"
}

400 Response

{
  "error": "FAILED",
  "message": "Cannot invoke \"String.startsWith(String)\" because \"path\" is null"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Search a zone for files

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/search \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/search

Returns a paginated list of files and folders (ZoneFileData) matching the given criteria.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	The identity of the zone to use.
caseSensitive	query	boolean	false	Determines if matching against includeNames and excludeNames shall be case sensitive or not.
excludeNames	query	string	false	Pattern for file and folder names to be excluded. The pattern shall be regular expression as defined for the Java String.matches method.By combining both includeNames and excludeNames, you can precisely control which files and folders are included or excluded in the response. Examples: .*~$ excludes files ending with ‘~’. .*\.zip$ excludes files ending with ‘.zip’.
groupFolders	query	boolean	false	True if folders are to be grouped.
includeFiles	query	boolean	false	True if files are to be included.
includeFolders	query	boolean	false	True if folders are to be included.
includeNames	query	string	false	Pattern for file and folder names to be included. The pattern shall be regular expression as defined for the Java String.matches method. By combining both includeNames and excludeNames, you can precisely control which files and folders are included or excluded in the response. Examples: .*\.txt$ Matches any string that ends with ‘.txt’ e.g. ‘hello.txt’. .*\.txt Matches any string that contains ‘.txt’ e.g. ‘hello.txt’ but also ‘hello.txt.log’. data.* Matches any string that starts with ‘data’. ^(report
page	query	integer	false	Pagination. The number of entries on a page
pageSize	query	integer(int32)	false	none
showDeleted	query	boolean	false	Show deleted files if true, show non deleted files if false.
zoneFileListOrdering	query	array[string]	false	An optional array of zero or more orderings of the returned entries. The orderings will be applied in the order they appear in the array.

Enumerated Values

Parameter	Value
zoneFileListOrdering	AscendingName
zoneFileListOrdering	DescendingName
zoneFileListOrdering	AscendingSuffix
zoneFileListOrdering	DescendingSuffix
zoneFileListOrdering	AscendingSize
zoneFileListOrdering	DescendingSize
zoneFileListOrdering	AscendingModification
zoneFileListOrdering	DescendingModification
zoneFileListOrdering	AscendingChange
zoneFileListOrdering	DescendingChange

Example responses

200 Response

[
  {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "availableActions": {
      "archive": false,
      "browse": false,
      "copy": false,
      "copyPath": true,
      "cut": false,
      "delete": true,
      "download": false,
      "downloadAuthenticationTimeout": 9223372036854776000,
      "exclude": true,
      "include": false,
      "lock": true,
      "newFolder": true,
      "open": false,
      "openConflict": false,
      "paste": false,
      "permanentDelete": true,
      "readEnable": false,
      "readProtect": true,
      "removeConflict": false,
      "rename": true,
      "restore": false,
      "showConflict": false,
      "showLog": true,
      "unlock": false,
      "upload": false,
      "useConflicting": false,
      "webLink": false,
      "writeEnable": false,
      "writeProtect": true
    },
    "deleted": false,
    "displayName": "findings.txt",
    "firstChanged": 1689060990207,
    "folder": false,
    "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
    "lastChanged": 1689061017879,
    "lastModified": "2023-07-11T09:36:53.273+02:00",
    "lastModifiedBy": "hans@greattools.net",
    "name": "findings.txt",
    "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
    "properName": "findings",
    "size": 48,
    "synchronizationStatus": "NotSynchronizing",
    "type": "TXT",
    "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600"
  }
]

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~24333361] (143ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneFileData]	false	none	[Data related to a file or a folder.]
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get file data

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/{fileid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/{fileid}

Gets the file data for the the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "availableActions": {
    "archive": false,
    "browse": false,
    "copy": false,
    "copyPath": true,
    "cut": false,
    "delete": true,
    "download": false,
    "downloadAuthenticationTimeout": 9223372036854776000,
    "exclude": true,
    "include": false,
    "lock": true,
    "newFolder": true,
    "open": false,
    "openConflict": false,
    "paste": false,
    "permanentDelete": true,
    "readEnable": false,
    "readProtect": true,
    "removeConflict": false,
    "rename": true,
    "restore": false,
    "showConflict": false,
    "showLog": true,
    "unlock": false,
    "upload": false,
    "useConflicting": false,
    "webLink": false,
    "writeEnable": false,
    "writeProtect": true
  },
  "deleted": false,
  "displayName": "findings.txt",
  "firstChanged": 1689060990207,
  "folder": false,
  "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
  "lastChanged": 1689061017879,
  "lastModified": "2023-07-11T09:36:53.273+02:00",
  "lastModifiedBy": "hans@greattools.net",
  "name": "findings.txt",
  "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
  "properName": "findings",
  "size": 48,
  "synchronizationStatus": "NotSynchronizing",
  "type": "TXT",
  "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete file

Code samples

# You can also use wget
curl -X DELETE /api/zones/{zoneid}/files/{fileid} \
  -H 'Accept: application/json'

DELETE /api/zones/{zoneid}/files/{fileid}

Deletes the file with the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path to the file. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
deletePermanent	query	boolean	false	If true permanently delete this file (cannot be undone).

Example responses

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update file attributes

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/attributes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/attributes

Updates all file attributes for the file with the given file id and zone.

Body parameter

{
  "writeProtected": false,
  "readProtected": false,
  "executable": false,
  "hidden": false,
  "synchronize": true
}

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
body	body	ZoneFileAttributes	false	none

Example responses

200 Response

[
  {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "deleted": false,
    "displayName": "laborum.pdf",
    "folder": false,
    "id": "830756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1",
    "lastModified": "2022-11-10T09:29:21.428+01:00",
    "lastModifiedBy": "chris@greattools.com",
    "lockedBy": "chris@greattools.com/63f03360ee82680c",
    "name": "laborum.pdf",
    "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
    "properName": "laborum",
    "size": 3365634,
    "synchronizationStatus": "NotSynchronizing",
    "type": "PDF",
    "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get file content

Code samples

# You can also use wget
curl -X HEAD /api/zones/{zoneid}/files/{fileid}/content \
  -H 'Accept: image/png' \
  -H 'Accept-Encoding: gzip' \
  -H 'Range: string'

HEAD /api/zones/{zoneid}/files/{fileid}/content

Gets the file content as an octet stream for the given file id and zone. Please note that when requesting READ PROTECTED content a revalidation might be needed.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path to the file. Note:It is always more efficient to specify an identity than a path.
zoneid	path	UUID	true	The identity of the zone to use.
useInline	query	boolean	false	Used to control the Content-Disposition header in the response. When true, serves the content inline in the browser (if supported). When false (default), forces a download as an attachment.
version	query	integer(int32)	false	Integer index of the file version to retrieve. Version (index) 0 is the current (latest) version. If omitted, defaults to the current (latest) version. Mutually exclusive with ‘versionTimestamp’.
versiontimestamp	query	string(date-time)	false	ISO-8601 timestamp (or Unix millis) specifying an exact file version. Must not be used together with ‘version’. If omitted, the current (latest) version is returned.
Accept-Encoding	header	string	false	Indicates the compression algorithms that the client can understand for
Range	header	string	false	An optional range indicating the part of a document that the server should return.

Detailed descriptions

Accept-Encoding: Indicates the compression algorithms that the client can understand for the response body.

Common values:

• gzip: Request gzip-compressed response.
• identity: Request uncompressed response.
• *: Accept any encoding (server picks best).

The server uses this header to perform HTTP content negotiation:

• If gzip is listed (and not disabled via gzip;q=0), the server may return a gzip-compressed stream and set Content-Encoding: gzip.
• If the client explicitly forbids gzip using gzip;q=0, the server will always return an uncompressed response.

Responses vary depending on the value of this header; therefore the server adds Vary: Accept-Encoding to support correct caching behavior.

Example responses

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

403 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	None
206	Partial Content	Partial Content returned	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline
415	Unsupported Media Type	Unsupported Media Type	Inline
416	Range Not Satisfiable	Requested range not satisfiable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 415

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 416

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Response Headers

Status	Header	Type	Format	Description
200	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
200	Content-Type	undefined		The MIME type of the returned content.
200	Content-Length	undefined		The size of the content in the current range.
200	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.
200	Vary	undefined		Instruct caches that content may or may not be compressed.
200	Content-Encoding	undefined		Indicates that the content is sent using compression and which type.
206	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
206	Content-Type	undefined		The MIME type of the returned content.
206	Vary	undefined		Instruct caches that content may or may not be compressed.
206	Content-Length	undefined		The size of the content in the current range.
206	Content-Range	undefined		The range of bytes returned in the response.
206	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.

Copy or Move file

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/copyormove/{folderid} \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/copyormove/{folderid}

Copy or move this file or folder to another folder.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file to be copied or moved.
folderid	path	string	true	The folder to move or copy the file to
zoneid	path	UUID	true	The identity of the zone to use.
move	query	boolean	false	True if the file or folder shall be moved, i.e. that the original file shall be deleted in the process. False if the file shall be copied.

Example responses

200 Response

[
  {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "deleted": false,
    "displayName": "laborum.pdf",
    "folder": false,
    "id": "830756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1",
    "lastModified": "2022-11-10T09:29:21.428+01:00",
    "lastModifiedBy": "chris@greattools.com",
    "lockedBy": "chris@greattools.com/63f03360ee82680c",
    "name": "laborum.pdf",
    "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
    "properName": "laborum",
    "size": 3365634,
    "synchronizationStatus": "NotSynchronizing",
    "type": "PDF",
    "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Lock a file using the Synkzone Distributed Lock

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/lock \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/lock

Sets a distributed file lock. The lock will ensure that the holder of the lock (on this specific node) is the only one who can make changes to the file. All other user can read the file but not produce any new versions until the lock is released. The owner of the lock and the zone manager can release the lock.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "laborum.pdf",
  "folder": false,
  "id": "830756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1",
  "lastModified": "2022-11-10T09:29:21.428+01:00",
  "lastModifiedBy": "chris@greattools.com",
  "lockedBy": "chris@greattools.com/63f03360ee82680c",
  "name": "laborum.pdf",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "laborum",
  "size": 3365634,
  "synchronizationStatus": "NotSynchronizing",
  "type": "PDF",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Release the (Synkzone Distributed File ) lock.

Code samples

# You can also use wget
curl -X DELETE /api/zones/{zoneid}/files/{fileid}/lock \
  -H 'Accept: application/json'

DELETE /api/zones/{zoneid}/files/{fileid}/lock

Release a distributed file lock. The owner of the lock and the zone manager can release the lock.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or a URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "laborum2",
  "folder": false,
  "id": "DE1405BE535B42DB9B4EA2B4C37D5C9808D6369D00000184172558CB3C69A453",
  "lastModified": "2022-11-07T17:01:06.922+01:00",
  "lastModifiedBy": "chris@goodtool.com",
  "name": "laborum2",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "laborum2",
  "size": 12,
  "synchronizationStatus": "NotSynchronizing",
  "type": "",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get file path elements

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/{fileid}/path \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/{fileid}/path

Gets all file path elements for the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file.
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

[
  {
    "elementId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573"
  },
  {
    "elementId": "830756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1",
    "elementName": "laborum.pdf"
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneFilePathElement]	false	none	none
» elementId	string	false	none	The zoneFileId of the element
» elementName	string	false	none	The elementName

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Rename file or folder

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/rename \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/rename

Rename this file or folder.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file (or an URLEncoded path) to be copied, moved, or renamed.Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
newfilename	query	string	false	The name of the new file or folder, or omitted if it shall keep the original name.

Example responses

200 Response

[
  {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "deleted": false,
    "displayName": "laborum.pdf",
    "folder": false,
    "id": "830756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1",
    "lastModified": "2022-11-10T09:29:21.428+01:00",
    "lastModifiedBy": "chris@greattools.com",
    "lockedBy": "chris@greattools.com/63f03360ee82680c",
    "name": "laborum.pdf",
    "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
    "properName": "laborum",
    "size": 3365634,
    "synchronizationStatus": "NotSynchronizing",
    "type": "PDF",
    "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Restore a deleted file

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/restore \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/restore

Restores a deleted file with the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

403 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

List file versions

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/{fileid}/versions \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/{fileid}/versions

Lists all the file version that exists for the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
showRemovedVersions	query	boolean	false	none

Example responses

200 Response

[
  {
    "created": "2022-11-10T09:29:21.428+01:00",
    "createdBy": "chris@goodtools.com",
    "index": 0,
    "removed": false,
    "size": 3365634,
    "stored": true
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneFileVersion]	false	none	none
» index	integer(int32)	false	none	The index of a list of versions
» size	integer(int64)	false	none	The file size of this version
» created	string	false	none	The timestamp of the file version creation (ISO-8601 extended offset date-time format).
» createdBy	string	false	none	The userId of the file version creator
» removed	boolean	false	none	True if version is removed
» stored	boolean	false	none	True if version is stored

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Switch file version

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/files/{fileid}/versions/{versiontimestamp} \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/files/{fileid}/versions/{versiontimestamp}

Switches the default version of a file with the given file id and zone.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file, or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
versiontimestamp	path	string	true	The version to use specified expressed as ISO8601 (Unix timestamp in Milliseconds).
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "laborum2",
  "folder": false,
  "id": "DE1405BE535B42DB9B4EA2B4C37D5C9808D6369D00000184172558CB3C69A453",
  "lastModified": "2022-11-07T17:01:06.922+01:00",
  "lastModifiedBy": "chris@goodtool.com",
  "name": "laborum2",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "laborum2",
  "size": 12,
  "synchronizationStatus": "NotSynchronizing",
  "type": "",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create (Upload) file

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/{folderid} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Content-Encoding: string'

POST /api/zones/{zoneid}/files/{folderid}

Uploads a new file with a unique name to the given folder in the given zone.

Body parameter

file: string
fileName: string
fileId: string

Parameters

Name	In	Type	Required	Description
folderid	path	string	true	The identity of the folder expressed as a fileid or as an URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
allowOverwrite	query	boolean	false	If a fileid is not specified and there is a matching file (a file with than name in the folder) a new version can be added by by setting this to true.
executable	query	boolean	false	File is executable.
hidden	query	boolean	false	File is hidden.
lastModified	query	string	false	The lastModified of the file expressed in ISO8601 (or a String representation of UNIX timestamp in milliseconds), if nothing is provided ‘current global time’ will be used.
readProtected	query	boolean	false	File should be read protected (requires authentication to access).
store-timeout	query	integer(int64)	false	Normally set to 0 (default) for a quicker response. If > 0, how long (ms) to wait for the file to become globally stored, if exceeded, the request fails with 408 Request Timeout (and the upload will be reversed, please try again with another lastModified if you provided one). If set to 0, the operation will return after registration but does not provide a guarantee that the file has been globally stored at this point.
synchronize	query	boolean	false	Specifies if the file should be synchronized (if ‘true’).
writeProtected	query	boolean	false	File should be write protected.
Content-Encoding	header	string	false	HTTP transfer encoding for the request body.
body	body	object	false	none
» file	body	string(binary)	false	The contents of the file expressed as an inputStream
» fileName	body	string	false	The name of the file
» fileId	body	string	false	The zoneFileId if the upload is expected to create a new version of an existing file, or null if the file is new.

Detailed descriptions

Content-Encoding: HTTP transfer encoding for the request body.

For multipart uploads, only the identity encoding is supported. Clients MUST NOT send Content-Encoding: gzip or other non-identity encodings with multipart/form-data requests.

If a compressed transfer is required, clients should either:

• Use the streaming upload endpoint that explicitly supports Content-Encoding=gzip and storeMode, or
• Compress the file data themselves (e.g. upload a .zip file) and send it as a regular, unencoded multipart part.

Example responses

201 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "laborum2",
  "folder": false,
  "id": "DE1405BE535B42DB9B4EA2B4C37D5C9808D6369D00000184172558CB3C69A453",
  "lastModified": "2022-11-07T17:01:06.922+01:00",
  "lastModifiedBy": "chris@goodtool.com",
  "name": "laborum2",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "laborum2",
  "size": 12,
  "synchronizationStatus": "NotSynchronizing",
  "type": "",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline
409	Conflict	Conflict	Inline
415	Unsupported Media Type	Unsupported Media Type	Inline

Response Schema

Status Code 201

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 415

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create (Upload) file as stream

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/{folderid}/stream?filename=string \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'Content-Encoding: string'

POST /api/zones/{zoneid}/files/{folderid}/stream

Uploads a stream of data as a unique name to the given zone.

Body parameter

string

Parameters

Name	In	Type	Required	Description
folderid	path	string	true	The identity of the folder to use, or the URLEncoded path to the folder. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
allowOverwrite	query	boolean	false	If a fileid is not specified and there is a matching file (a file with than name in the folder) a new version can be added by by setting this to true.
executable	query	boolean	false	File is executable.
fileid	query	string	false	The identity of the file to write a new version to or empty for a new file.
filename	query	string	true	The name of the file.
hidden	query	boolean	false	File is hidden.
lastModified	query	string	false	The lastModified of the file expressed in ISO8601 (or a String representation of UNIX timestamp in milliseconds), if nothing is provided ‘current global time’ will be used.
readProtected	query	boolean	false	File should be read protected (requires authentication to access).
store-timeout	query	integer(int64)	false	Normally set to 0 (default) for a quicker response. If > 0, how long (ms) to wait for the file to become globally stored, if exceeded, the request fails with 408 Request Timeout (and the upload will be reversed, please try again with another lastModified if you provided one). If set to 0, the operation will return after registration but does not provide a guarantee that the file has been globally stored at this point.
storeMode	query	string	false	Either preserve uploaded content regardless of HTTP header Content-Encoding or canonical decode any compressed content, if HTTP Header Content-Encoding=gzip (default).
synchronize	query	boolean	false	File should be synchronized (if true).
writeProtected	query	boolean	false	File should be write protected.
Content-Encoding	header	string	false	none
body	body	string(binary)	false	none

Example responses

201 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "laborum2",
  "folder": false,
  "id": "DE1405BE535B42DB9B4EA2B4C37D5C9808D6369D00000184172558CB3C69A453",
  "lastModified": "2022-11-07T17:01:06.922+01:00",
  "lastModifiedBy": "chris@goodtool.com",
  "name": "laborum2",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "laborum2",
  "size": 12,
  "synchronizationStatus": "NotSynchronizing",
  "type": "",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

408 Response

{
  "error": "TIMEOUT",
  "message": "File upload time out"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline
408	Request Timeout	Request Timeout	Inline
409	Conflict	Conflict	Inline
415	Unsupported Media Type	Unsupported Media Type	Inline

Response Schema

Status Code 201

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 415

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

List contents of the given folder

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/folder/{folderid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/folder/{folderid}

Lists all the content of the given folder in the given zone and folderid.

Parameters

Name	In	Type	Required	Description
folderid	path	string	true	The identity of the folder to use or the URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
caseSensitive	query	boolean	false	Determines if matching against includeNames and excludeNames shall be case sensitive or not.
excludeNames	query	string	false	Pattern for file and folder names to be excluded. The pattern shall be regular expression as defined for the Java String.matches method.
groupFolders	query	boolean	false	True if folders are to be grouped.
includeFiles	query	boolean	false	True if files are to be included.
includeFolders	query	boolean	false	True if folders are to be included.
includeNames	query	string	false	Pattern for file and folder names to be included. The pattern shall be regular expression as defined for the Java String.matches method.
page	query	integer	false	Pagination. The number of entries on a page
pageSize	query	integer(int32)	false	none
showDeleted	query	boolean	false	Show deleted files if true, show non deleted files if false.
zoneFileListOrdering	query	array[string]	false	An optional array of zero or more orderings of the returned entries. The orderings will be applied in the order they appear in the array.

Enumerated Values

Parameter	Value
zoneFileListOrdering	AscendingName
zoneFileListOrdering	DescendingName
zoneFileListOrdering	AscendingSuffix
zoneFileListOrdering	DescendingSuffix
zoneFileListOrdering	AscendingSize
zoneFileListOrdering	DescendingSize
zoneFileListOrdering	AscendingModification
zoneFileListOrdering	DescendingModification
zoneFileListOrdering	AscendingChange
zoneFileListOrdering	DescendingChange

Example responses

200 Response

[
  {
    "attributes": {
      "executable": false,
      "hidden": false,
      "readProtected": false,
      "synchronize": true,
      "writeProtected": false
    },
    "availableActions": {
      "archive": false,
      "browse": false,
      "copy": false,
      "copyPath": true,
      "cut": false,
      "delete": true,
      "download": false,
      "downloadAuthenticationTimeout": 9223372036854776000,
      "exclude": true,
      "include": false,
      "lock": true,
      "newFolder": true,
      "open": false,
      "openConflict": false,
      "paste": false,
      "permanentDelete": true,
      "readEnable": false,
      "readProtect": true,
      "removeConflict": false,
      "rename": true,
      "restore": false,
      "showConflict": false,
      "showLog": true,
      "unlock": false,
      "upload": false,
      "useConflicting": false,
      "webLink": false,
      "writeEnable": false,
      "writeProtect": true
    },
    "deleted": false,
    "displayName": "findings.txt",
    "firstChanged": 1689060990207,
    "folder": false,
    "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
    "lastChanged": 1689061017879,
    "lastModified": "2023-07-11T09:36:53.273+02:00",
    "lastModifiedBy": "hans@greattools.net",
    "name": "findings.txt",
    "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
    "properName": "findings",
    "size": 48,
    "synchronizationStatus": "NotSynchronizing",
    "type": "TXT",
    "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600"
  }
]

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~24333361] (143ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573)"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneFileData]	false	none	[Data related to a file or a folder.]
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create new folder

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/folder/{folderid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/zones/{zoneid}/folder/{folderid}

Creates a new folder with the given name and attribute in the given zone and given root folder.

Body parameter

{
  "newFolderName": "string",
  "attributes": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  }
}

Parameters

Name	In	Type	Required	Description
folderid	path	string	true	The identity of the folder where you want to create the new folder, or an URLEncoded path. Example: the path path/to/file.txt send as path%2Fto%2Ffile.txt
zoneid	path	UUID	true	The identity of the zone to use.
body	body	NewFolder	false	none

Example responses

201 Response

{
  "attributes": {
    "executable": false,
    "hidden": false,
    "readProtected": false,
    "synchronize": true,
    "writeProtected": false
  },
  "deleted": false,
  "displayName": "Pictures220323",
  "folder": true,
  "id": "000000000000000000000000000000014CAD37D2000001861746D4DDDEF65858",
  "lastModified": "2023-02-24T19:06:00.634+01:00",
  "lastModifiedBy": "christer.wik@synkzone.test",
  "name": "Pictures220323",
  "parentId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "properName": "Pictures220323",
  "size": -1,
  "synchronizationStatus": "NotSynchronizing",
  "type": "",
  "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NOT_FOUND",
  "message": "Cannot find ZoneFileId [~67f7085f] (730756F9DE0D40C8B645565B241C023798F5C00C0000018417262C257D2119F1)"
}

406 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline
409	Conflict	Conflict	Inline

Response Schema

Status Code 201

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Group

All operations related to group management.

List Groups

Code samples

# You can also use wget
curl -X GET /api/groups \
  -H 'Accept: application/json'

GET /api/groups

List all groups that are visible for this user.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Pagination: Provide this page number start from 1
pageSize	query	integer	false	Pagination: page size

Example responses

200 Response

[
  {
    "administratorManaged": true,
    "createdAt": "2024-04-24T13:17:33.836+02:00",
    "createdBy": "bob@example.com",
    "description": "Economy workers",
    "groupId": "group.f4e89e66-8edc-40da-9245-d46251d6ffd8@example.com",
    "name": "Economy",
    "open": true,
    "zoneActions": {
      "assignAccessRights": true
    }
  }
]

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GroupProperties]	false	none	none
» groupId	string	false	none	The id of the group.
» externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
» name	string	false	none	The name of the group.
» description	string	false	none	A description of the group.
» createdAt	string	false	none	Date when the group was created, expressed in ISO8601 extended offset date-time format.
» createdBy	string	false	none	Name of the user that created the zone.
» allowedActions	GroupActions	false	none	The actions that the current user can perform on the group.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
» administratorManaged	boolean	false	none	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
» open	boolean	false	none	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.
» zoneActions	GroupActions	false	none	Class used to to describe what actions a user is allowed to do.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create a group

Code samples

# You can also use wget
curl -X POST /api/groups \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/groups

Creates a new group with members.

Body parameter

{
  "properties": {
    "groupId": "string",
    "externalId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2011-12-03T10:15:30+01:00",
    "createdBy": "string",
    "allowedActions": {
      "assignAccessRights": true
    },
    "administratorManaged": true,
    "open": true,
    "zoneActions": {
      "assignAccessRights": true
    }
  },
  "members": [
    {
      "memberId": "string",
      "displayName": "string",
      "authorization": "None",
      "accessLevel": "None",
      "memberType": "User"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» properties	body	GroupProperties	false	A collection of properties for the group.
»» groupId	body	string	false	The id of the group.
»» externalId	body	string	false	Identifier for this group with an external IDP, which can be used for user database synchronization.
»» name	body	string	false	The name of the group.
»» description	body	string	false	A description of the group.
»» createdAt	body	string	false	Date when the group was created, expressed in ISO8601 extended offset date-time format.
»» createdBy	body	string	false	Name of the user that created the zone.
»» allowedActions	body	GroupActions	false	The actions that the current user can perform on the group.
»»» assignAccessRights	body	boolean	false	The current user can assign or remove access rights for coworkers (but not self
»» administratorManaged	body	boolean	false	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
»» open	body	boolean	false	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker.
»» zoneActions	body	GroupActions	false	Class used to to describe what actions a user is allowed to do.
»»» assignAccessRights	body	boolean	false	The current user can assign or remove access rights for coworkers (but not self
» members	body	[GroupMember]	false	The list of members in the group.
»» memberId	body	string	false	none
»» displayName	body	string	false	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	body	UserAuthorizationData	false	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» accessLevel	body	GroupAccessLevel	false	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» memberType	body	MemberType	false	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

Detailed descriptions

»» open: Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.

Enumerated Values

Parameter	Value
»» authorization	None
»» authorization	Removed
»» authorization	Inactive
»» authorization	Group
»» authorization	Visitor
»» authorization	Guest
»» authorization	External
»» authorization	Internal
»» authorization	Manager
»» authorization	Administrator
»» authorization	Recovery
»» authorization	Main
»» accessLevel	None
»» accessLevel	Access
»» accessLevel	Manage
»» memberType	User
»» memberType	Group

Example responses

201 Response

{
  "properties": {
    "groupId": "string",
    "externalId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2011-12-03T10:15:30+01:00",
    "createdBy": "string",
    "allowedActions": {
      "assignAccessRights": true
    },
    "administratorManaged": true,
    "open": true,
    "zoneActions": {
      "assignAccessRights": true
    }
  },
  "members": [
    {
      "memberId": "string",
      "displayName": "string",
      "authorization": "None",
      "accessLevel": "None",
      "memberType": "User"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» properties	GroupProperties	false	none	A collection of properties for the group.
»» groupId	string	false	none	The id of the group.
»» externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
»» name	string	false	none	The name of the group.
»» description	string	false	none	A description of the group.
»» createdAt	string	false	none	Date when the group was created, expressed in ISO8601 extended offset date-time format.
»» createdBy	string	false	none	Name of the user that created the zone.
»» allowedActions	GroupActions	false	none	The actions that the current user can perform on the group.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
»» administratorManaged	boolean	false	none	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
»» open	boolean	false	none	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.
»» zoneActions	GroupActions	false	none	Class used to to describe what actions a user is allowed to do.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
» members	[GroupMember]	false	none	The list of members in the group.
»» memberId	string	false	none	none
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» accessLevel	GroupAccessLevel	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
accessLevel	None
accessLevel	Access
accessLevel	Manage
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get information about the Group

Code samples

# You can also use wget
curl -X GET /api/groups/{groupid} \
  -H 'Accept: application/json'

GET /api/groups/{groupid}

Gets group information for the group with the given group id.

Parameters

Name	In	Type	Required	Description
groupid	path	string	true	The identity of the group.

Example responses

200 Response

{
  "members": [
    {
      "accessLevel": "Manage",
      "authorization": "Administrator",
      "displayName": "martin",
      "memberId": "martin@example.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Access",
      "authorization": "Internal",
      "displayName": "bob",
      "memberId": "bob@example.com",
      "memberType": "User"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T13:23:14.507+02:00",
    "createdBy": "martin@example.com",
    "description": "Security classified coworkers",
    "groupId": "group.d3a60316-2de5-4d4a-aa30-67b5bcf40c48@example.com",
    "name": "Classified",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» properties	GroupProperties	false	none	A collection of properties for the group.
»» groupId	string	false	none	The id of the group.
»» externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
»» name	string	false	none	The name of the group.
»» description	string	false	none	A description of the group.
»» createdAt	string	false	none	Date when the group was created, expressed in ISO8601 extended offset date-time format.
»» createdBy	string	false	none	Name of the user that created the zone.
»» allowedActions	GroupActions	false	none	The actions that the current user can perform on the group.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
»» administratorManaged	boolean	false	none	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
»» open	boolean	false	none	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.
»» zoneActions	GroupActions	false	none	Class used to to describe what actions a user is allowed to do.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
» members	[GroupMember]	false	none	The list of members in the group.
»» memberId	string	false	none	none
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» accessLevel	GroupAccessLevel	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
accessLevel	None
accessLevel	Access
accessLevel	Manage
memberType	User
memberType	Group

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update group

Code samples

# You can also use wget
curl -X PUT /api/groups/{groupid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/groups/{groupid}

Updates group properties and group memberships. Note there is also a separate method if you want to set or modify the access level for one single member.

Body parameter

{
  "properties": {
    "groupId": "string",
    "externalId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2011-12-03T10:15:30+01:00",
    "createdBy": "string",
    "allowedActions": {
      "assignAccessRights": true
    },
    "administratorManaged": true,
    "open": true,
    "zoneActions": {
      "assignAccessRights": true
    }
  },
  "members": [
    {
      "memberId": "string",
      "displayName": "string",
      "authorization": "None",
      "accessLevel": "None",
      "memberType": "User"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
groupid	path	string	true	The identity of the group.
relative	query	boolean	false	Indicates whether the list of access rights (members) represents CHANGES to the current access rights or if the specified access rights shall REPLACE the current access rights.
body	body	object	true	none
» properties	body	GroupProperties	false	A collection of properties for the group.
»» groupId	body	string	false	The id of the group.
»» externalId	body	string	false	Identifier for this group with an external IDP, which can be used for user database synchronization.
»» name	body	string	false	The name of the group.
»» description	body	string	false	A description of the group.
»» createdAt	body	string	false	Date when the group was created, expressed in ISO8601 extended offset date-time format.
»» createdBy	body	string	false	Name of the user that created the zone.
»» allowedActions	body	GroupActions	false	The actions that the current user can perform on the group.
»»» assignAccessRights	body	boolean	false	The current user can assign or remove access rights for coworkers (but not self
»» administratorManaged	body	boolean	false	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
»» open	body	boolean	false	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker.
»» zoneActions	body	GroupActions	false	Class used to to describe what actions a user is allowed to do.
»»» assignAccessRights	body	boolean	false	The current user can assign or remove access rights for coworkers (but not self
» members	body	[GroupMember]	false	The list of members in the group.
»» memberId	body	string	false	none
»» displayName	body	string	false	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	body	UserAuthorizationData	false	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» accessLevel	body	GroupAccessLevel	false	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» memberType	body	MemberType	false	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

Detailed descriptions

relative: Indicates whether the list of access rights (members) represents CHANGES to the current access rights or if the specified access rights shall REPLACE the current access rights. true: The provided list of access rights represents changes to the current access rights.

false: The specified access rights shall replace the current access rights entirely.

»» open: Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.

Enumerated Values

Parameter	Value
»» authorization	None
»» authorization	Removed
»» authorization	Inactive
»» authorization	Group
»» authorization	Visitor
»» authorization	Guest
»» authorization	External
»» authorization	Internal
»» authorization	Manager
»» authorization	Administrator
»» authorization	Recovery
»» authorization	Main
»» accessLevel	None
»» accessLevel	Access
»» accessLevel	Manage
»» memberType	User
»» memberType	Group

Example responses

200 Response

{
  "members": [
    {
      "accessLevel": "Manage",
      "authorization": "Administrator",
      "displayName": "martin",
      "memberId": "martin@example.com",
      "memberType": "User"
    },
    {
      "accessLevel": "Access",
      "authorization": "Internal",
      "displayName": "bob",
      "memberId": "bob@example.com",
      "memberType": "User"
    }
  ],
  "properties": {
    "administratorManaged": false,
    "createdAt": "2024-04-26T13:23:14.507+02:00",
    "createdBy": "martin@example.com",
    "description": "Security classified coworkers",
    "groupId": "d3a60316-2de5-4d4a-aa30-67b5bcf40c48",
    "name": "Classified",
    "open": true,
    "zoneActions": {
      "assignAccessRights": false
    }
  }
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» properties	GroupProperties	false	none	A collection of properties for the group.
»» groupId	string	false	none	The id of the group.
»» externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
»» name	string	false	none	The name of the group.
»» description	string	false	none	A description of the group.
»» createdAt	string	false	none	Date when the group was created, expressed in ISO8601 extended offset date-time format.
»» createdBy	string	false	none	Name of the user that created the zone.
»» allowedActions	GroupActions	false	none	The actions that the current user can perform on the group.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
»» administratorManaged	boolean	false	none	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
»» open	boolean	false	none	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.
»» zoneActions	GroupActions	false	none	Class used to to describe what actions a user is allowed to do.
»»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self
» members	[GroupMember]	false	none	The list of members in the group.
»» memberId	string	false	none	none
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» accessLevel	GroupAccessLevel	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
accessLevel	None
accessLevel	Access
accessLevel	Manage
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete Group

Code samples

# You can also use wget
curl -X DELETE /api/groups/{groupid} \
  -H 'Accept: application/json'

DELETE /api/groups/{groupid}

Deletes the group with the given group id.

Parameters

Name	In	Type	Required	Description
groupid	path	string	true	The identity of the group.

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Change access level

Code samples

# You can also use wget
curl -X PUT /api/groups/{groupid}/members/{memberid}?accesslevel=Access \
  -H 'Accept: application/json'

PUT /api/groups/{groupid}/members/{memberid}

Change the access level of a single user or group with the given memberid for the group with the given groupid. Note: There is a separate method that allows you to change several member accesslevels at the same time.

Parameters

Name	In	Type	Required	Description
groupid	path	string	true	none
memberid	path	string	true	none
accesslevel	query	string	true	The access level. Only Access, None and Manage are allowed.

Example responses

200 Response

"Manage"

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

MultipartUpload

Support for uploading large files in parts and assemble them.

List uploads

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/multipart \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/multipart

List all ongoing multipart uploads.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Executed successfully.	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Initiate multipart upload

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/multipart/init/{folderid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/zones/{zoneid}/files/multipart/init/{folderid}

Starts a new multipart upload to the given zone.

Body parameter

{
  "fileid": "string",
  "fileName": "string",
  "lastModified": "",
  "zoneFileAttributesData": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  },
  "allowOverwrite": true
}

Parameters

Name	In	Type	Required	Description
folderid	path	string	true	The identity of the folder or the URLEncoded path to the folder. Note:It is always more efficient to specify an identity than a path.
zoneid	path	UUID	true	The id of the zone.
body	body	MultiPartInitRequest	false	none

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
409	Conflict	Conflict	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	UUID(uuid)	true	none	The id of a MultiPartUpload.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete/abort multipart upload

Code samples

# You can also use wget
curl -X DELETE /api/zones/{zoneid}/files/multipart/{uploadId} \
  -H 'Accept: application/json'

DELETE /api/zones/{zoneid}/files/multipart/{uploadId}

Cancel and delete everything associated with this multipart upload.

Parameters

Name	In	Type	Required	Description
uploadId	path	UUID	true	The ‘upload Identity’ provided at initialization.
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Executed Successfully.	None
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get Multipart upload completion (assembly) result

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/multipart/{uploadId}/complete \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/multipart/{uploadId}/complete

Retrieve the result of a previous complete request. If assembly is not ready a 404 will be returned.

Parameters

Name	In	Type	Required	Description
uploadId	path	UUID	true	The ‘upload Identity’ provided at initialization.
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600",
  "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
  "name": "hello.txt",
  "properName": "hello",
  "displayName": "hello.txt",
  "type": "TXT",
  "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
  "folder": true,
  "deleted": true,
  "size": 0,
  "lastModified": "2011-12-03T10:15:30+01:00",
  "lastModifiedBy": "bob@example.com",
  "attributes": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  },
  "lockedBy": "string",
  "synchronizationStatus": "Unknown",
  "availableActions": {
    "open": true,
    "openConflict": true,
    "showConflict": true,
    "removeConflict": true,
    "useConflicting": true,
    "browse": true,
    "copyPath": true,
    "lock": true,
    "unlock": true,
    "writeProtect": true,
    "writeEnable": true,
    "readProtect": true,
    "readEnable": true,
    "exclude": true,
    "include": true,
    "restore": true,
    "download": true,
    "upload": true,
    "archive": true,
    "cut": true,
    "copy": true,
    "paste": true,
    "newFolder": true,
    "rename": true,
    "delete": true,
    "permanentDelete": true,
    "webLink": true,
    "showLog": true,
    "downloadAuthenticationTimeout": 0,
    "newFile": true,
    "update": true
  },
  "zoneFileDownloadStatus": {
    "percentDownloaded": 0,
    "averageDownloadSpeed": 0,
    "estimatedRemainingDownloadTime": 0
  },
  "lastChanged": "2011-12-03T10:15:30+01:00",
  "firstChanged": "2011-12-03T10:15:30+01:00",
  "metadataMap": "2011-12-03T10:15:30+01:00"
}

Responses

Status	Meaning	Description	Schema
200	OK	Executed Successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
409	Conflict	Conflicted	Inline

Response Schema

Status Code 200

Data related to a file or a folder.

Name	Type	Required	Restrictions	Description
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Complete upload (assemble parts)

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/multipart/{uploadId}/complete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/zones/{zoneid}/files/multipart/{uploadId}/complete

Inititate a MultiPart completion by order assembly and registration of parts. Assembly takes time, please poll endpoint using GET method to check if result is available.

Body parameter

{
  "parts": [
    {
      "partNumber": 1,
      "partMd5": "string",
      "length": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
uploadId	path	UUID	true	The ‘upload Identity’ provided at initialization.
zoneid	path	UUID	true	The identity of the zone to use.
body	body	MultiPartUpload	false	none

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	An assembly was initiated.	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found, returned when uploadId was not found or the assembly has not completed yet.	Inline
409	Conflict	Conflict	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

list Parts

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/files/multipart/{uploadId}/part \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/files/multipart/{uploadId}/part

List parts of an ongoing multipart upload

Parameters

Name	In	Type	Required	Description
uploadId	path	UUID	true	The ‘upload Identity’ provided at initialization.
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

{
  "parts": [
    {
      "partNumber": 1,
      "partMd5": "string",
      "length": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Executed Successfully.	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» parts	[MultiPart]	false	none	An array of parts
»» partNumber	integer(int32)	false	none	The partnumber
»» partMd5	string	false	none	The MD5 checksum of this part
»» length	integer(int64)	false	none	The number of bytes of this part

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Upload part

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/files/multipart/{uploadId}/part?partnum=1 \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'Content-Encoding: string'

POST /api/zones/{zoneid}/files/multipart/{uploadId}/part

Upload a part to a MultiPart upload. If the part allready exists it will be overwritten.

Body parameter

string

Parameters

Name	In	Type	Required	Description
uploadId	path	UUID	true	The ‘upload Identity’ provided at initialization.
zoneid	path	UUID	true	The identity of the zone to use.
partnum	query	integer	true	The part number to upload.
Content-Encoding	header	string	false	HTTP transfer encoding for the request body.
body	body	string(binary)	false	none

Detailed descriptions

Content-Encoding: HTTP transfer encoding for the request body.

For multipart uploads, only the identity encoding is supported. Clients MUST NOT send Content-Encoding: gzip or other non-identity encodings with multipart/form-data requests.

Example responses

200 Response

{
  "partNumber": 1,
  "partMd5": "string",
  "length": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
409	Conflict	Conflicted	Inline
415	Unsupported Media Type	Unsupported Media Type	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» partNumber	integer(int32)	false	none	The partnumber
» partMd5	string	false	none	The MD5 checksum of this part
» length	integer(int64)	false	none	The number of bytes of this part

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 415

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

OAuth2

Operations to support OAuth2

List all OAuth2 Clients

Code samples

# You can also use wget
curl -X GET /api/clients \
  -H 'Accept: application/json'

GET /api/clients

List all registered OAuth2 clients. Can only be called by Main Administrator.

Example responses

200 Response

[
  {
    "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
    "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
    "client_id_issued_at": 2893256800,
    "client_secret_expires_at": 2893276800,
    "registrationClientURI": "string",
    "token_endpoint_auth_method": "client_secret_basic",
    "grant_types": "authorization_code",
    "response_types": "code",
    "redirect_uris": "https://client.example.org/callback",
    "client_name": "Photo Quality Printer",
    "client_uri": "https://client.example.net/",
    "logo_uri": "string",
    "contacts": [
      "string"
    ],
    "tos_uri": "string",
    "policy_uri": "string",
    "software_id": "4NRB1-0XZABZI9E6-5SM3R",
    "software_version": "string",
    "scopes": [
      {
        "name": "string",
        "description": "string",
        "clients": [
          "Test"
        ],
        "permissions": {
          "property1": {
            "all": true,
            "create": true,
            "list": true,
            "get": true,
            "access": true,
            "modify": true,
            "delete": true
          },
          "property2": {
            "all": true,
            "create": true,
            "list": true,
            "get": true,
            "access": true,
            "modify": true,
            "delete": true
          }
        },
        "limitations": {
          "property1": null,
          "property2": null
        },
        "extensions": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "token": "string",
    "tokenExpiry": 0,
    "clientIdentifier": "string",
    "clientSecret": "string",
    "clientIdentifierIssuedAt": 0,
    "clientSecretExpiresAt": 0,
    "tokenEndpointAuthorizationMethod": "string",
    "grantTypes": [
      "string"
    ],
    "responseTypes": [
      "string"
    ],
    "redirectURIs": [
      "string"
    ],
    "clientName": "string",
    "clientURI": "string",
    "logoURI": "string",
    "tosURI": "string",
    "policyURI": "string",
    "softwareId": "string",
    "softwareVersion": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
500	Internal Server Error	Internal service error	Inline
503	Service Unavailable	Service unavailable	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[OAuth2ClientRegistrationData]	false	none	[Oauth2 Client Data according to DCRM.]
» client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
» client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
» client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
» token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
» grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
» response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
» redirect_uris	[string]	false	none	URI for redirect of authorization responses
» client_name	string	false	none	Human readable name of the client
» client_uri	string	false	none	Link to client information page to display during authorization
» logo_uri	string	false	none	Link to client logo to display during authorization
» contacts	[string]	false	none	How to contact client supplier
» tos_uri	string	false	none	Link to terms of service to display during authorization
» policy_uri	string	false	none	Link to privacy policy to display during authorization
» software_id	string	false	none	Client supplier’s unique id for the client
» software_version	string	false	none	Client supplier’s software version number
» scopes	[SPScope]	false	none	Scopes that the client are allowed to use
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
» tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» clientIdentifier	string	false	none	none
» clientSecret	string	false	none	none
» clientIdentifierIssuedAt	integer(int64)	false	none	none
» clientSecretExpiresAt	integer(int64)	false	none	none
» tokenEndpointAuthorizationMethod	string	false	none	none
» grantTypes	[string]	false	none	none
» responseTypes	[string]	false	none	none
» redirectURIs	[string]	false	none	none
» clientName	string	false	none	none
» clientURI	string	false	none	none
» logoURI	string	false	none	none
» tosURI	string	false	none	none
» policyURI	string	false	none	none
» softwareId	string	false	none	none
» softwareVersion	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Register OAuth2 Client

Code samples

# You can also use wget
curl -X POST /api/clients \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/clients

Register OAuth2 client (according to the Dynamic Client Registration(DCR) standard RFC7591). Can only be called by Main Administrator.

Body parameter

{
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	OAuth2ClientRegistrationInData	false	none

Example responses

200 Response

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
500	Internal Server Error	Internal service error	Inline
503	Service Unavailable	Service unavailable	None

Response Schema

Status Code 200

Oauth2 Client Data according to DCRM.

Name	Type	Required	Restrictions	Description
» client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
» client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
» client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
» token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
» grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
» response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
» redirect_uris	[string]	false	none	URI for redirect of authorization responses
» client_name	string	false	none	Human readable name of the client
» client_uri	string	false	none	Link to client information page to display during authorization
» logo_uri	string	false	none	Link to client logo to display during authorization
» contacts	[string]	false	none	How to contact client supplier
» tos_uri	string	false	none	Link to terms of service to display during authorization
» policy_uri	string	false	none	Link to privacy policy to display during authorization
» software_id	string	false	none	Client supplier’s unique id for the client
» software_version	string	false	none	Client supplier’s software version number
» scopes	[SPScope]	false	none	Scopes that the client are allowed to use
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
» tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» clientIdentifier	string	false	none	none
» clientSecret	string	false	none	none
» clientIdentifierIssuedAt	integer(int64)	false	none	none
» clientSecretExpiresAt	integer(int64)	false	none	none
» tokenEndpointAuthorizationMethod	string	false	none	none
» grantTypes	[string]	false	none	none
» responseTypes	[string]	false	none	none
» redirectURIs	[string]	false	none	none
» clientName	string	false	none	none
» clientURI	string	false	none	none
» logoURI	string	false	none	none
» tosURI	string	false	none	none
» policyURI	string	false	none	none
» softwareId	string	false	none	none
» softwareVersion	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get OAuth2 Client

Code samples

# You can also use wget
curl -X GET /api/clients/{clientid} \
  -H 'Accept: application/json'

GET /api/clients/{clientid}

Get registered OAuth2 client (DCR-M). Can only be called by Main Administrator.

Parameters

Name	In	Type	Required	Description
clientid	path	string	true	The identity of the client to retrieve information about.

Example responses

200 Response

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
500	Internal Server Error	Internal service error	Inline
503	Service Unavailable	Service unavailable	None

Response Schema

Status Code 200

Oauth2 Client Data according to DCRM.

Name	Type	Required	Restrictions	Description
» client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
» client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
» client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
» token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
» grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
» response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
» redirect_uris	[string]	false	none	URI for redirect of authorization responses
» client_name	string	false	none	Human readable name of the client
» client_uri	string	false	none	Link to client information page to display during authorization
» logo_uri	string	false	none	Link to client logo to display during authorization
» contacts	[string]	false	none	How to contact client supplier
» tos_uri	string	false	none	Link to terms of service to display during authorization
» policy_uri	string	false	none	Link to privacy policy to display during authorization
» software_id	string	false	none	Client supplier’s unique id for the client
» software_version	string	false	none	Client supplier’s software version number
» scopes	[SPScope]	false	none	Scopes that the client are allowed to use
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
» tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» clientIdentifier	string	false	none	none
» clientSecret	string	false	none	none
» clientIdentifierIssuedAt	integer(int64)	false	none	none
» clientSecretExpiresAt	integer(int64)	false	none	none
» tokenEndpointAuthorizationMethod	string	false	none	none
» grantTypes	[string]	false	none	none
» responseTypes	[string]	false	none	none
» redirectURIs	[string]	false	none	none
» clientName	string	false	none	none
» clientURI	string	false	none	none
» logoURI	string	false	none	none
» tosURI	string	false	none	none
» policyURI	string	false	none	none
» softwareId	string	false	none	none
» softwareVersion	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update OAuth2 Client

Code samples

# You can also use wget
curl -X PUT /api/clients/{clientid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/clients/{clientid}

Update OAuth2 client (according to DCR-M). Can only be called by Main Administrator.

Body parameter

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Parameters

Name	In	Type	Required	Description
clientid	path	string	true	The identity of the client to retrieve information about.
body	body	OAuth2ClientRegistrationData	false	none

Example responses

200 Response

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
500	Internal Server Error	Internal service error	Inline
503	Service Unavailable	Service unavailable	None

Response Schema

Status Code 200

Oauth2 Client Data according to DCRM.

Name	Type	Required	Restrictions	Description
» client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
» client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
» client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
» token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
» grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
» response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
» redirect_uris	[string]	false	none	URI for redirect of authorization responses
» client_name	string	false	none	Human readable name of the client
» client_uri	string	false	none	Link to client information page to display during authorization
» logo_uri	string	false	none	Link to client logo to display during authorization
» contacts	[string]	false	none	How to contact client supplier
» tos_uri	string	false	none	Link to terms of service to display during authorization
» policy_uri	string	false	none	Link to privacy policy to display during authorization
» software_id	string	false	none	Client supplier’s unique id for the client
» software_version	string	false	none	Client supplier’s software version number
» scopes	[SPScope]	false	none	Scopes that the client are allowed to use
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
» tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» clientIdentifier	string	false	none	none
» clientSecret	string	false	none	none
» clientIdentifierIssuedAt	integer(int64)	false	none	none
» clientSecretExpiresAt	integer(int64)	false	none	none
» tokenEndpointAuthorizationMethod	string	false	none	none
» grantTypes	[string]	false	none	none
» responseTypes	[string]	false	none	none
» redirectURIs	[string]	false	none	none
» clientName	string	false	none	none
» clientURI	string	false	none	none
» logoURI	string	false	none	none
» tosURI	string	false	none	none
» policyURI	string	false	none	none
» softwareId	string	false	none	none
» softwareVersion	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete OAuth2 Client

Code samples

# You can also use wget
curl -X DELETE /api/clients/{clientid} \
  -H 'Accept: application/json'

DELETE /api/clients/{clientid}

Delete registered OAuth2 client (according to DCR-M). Can only be called by Main Administrator.

Parameters

Name	In	Type	Required	Description
clientid	path	string	true	The identity of the client to retrieve information about.

Example responses

200 Response

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	Inline
406	Not Acceptable	Not Acceptable	Inline
500	Internal Server Error	Internal service error	Inline
503	Service Unavailable	Service unavailable	None

Response Schema

Status Code 200

Oauth2 Client Data according to DCRM.

Name	Type	Required	Restrictions	Description
» client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
» client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
» client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
» token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
» grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
» response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
» redirect_uris	[string]	false	none	URI for redirect of authorization responses
» client_name	string	false	none	Human readable name of the client
» client_uri	string	false	none	Link to client information page to display during authorization
» logo_uri	string	false	none	Link to client logo to display during authorization
» contacts	[string]	false	none	How to contact client supplier
» tos_uri	string	false	none	Link to terms of service to display during authorization
» policy_uri	string	false	none	Link to privacy policy to display during authorization
» software_id	string	false	none	Client supplier’s unique id for the client
» software_version	string	false	none	Client supplier’s software version number
» scopes	[SPScope]	false	none	Scopes that the client are allowed to use
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
» tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
» clientIdentifier	string	false	none	none
» clientSecret	string	false	none	none
» clientIdentifierIssuedAt	integer(int64)	false	none	none
» clientSecretExpiresAt	integer(int64)	false	none	none
» tokenEndpointAuthorizationMethod	string	false	none	none
» grantTypes	[string]	false	none	none
» responseTypes	[string]	false	none	none
» redirectURIs	[string]	false	none	none
» clientName	string	false	none	none
» clientURI	string	false	none	none
» logoURI	string	false	none	none
» tosURI	string	false	none	none
» policyURI	string	false	none	none
» softwareId	string	false	none	none
» softwareVersion	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

OAuth2 Get Access Token

Code samples

# You can also use wget
curl -X POST /api/oauth2/access \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json'

POST /api/oauth2/access

Exchange an authorization against a token that corresponds to a SPAccess.

Body parameter

code: string
redirect_uri: string
client_id: string
client_secret: string
code_verifier: string

Parameters

Name	In	Type	Required	Description
grant_type	query	string	false	none
body	body	object	false	none
» code	body	string	false	none
» redirect_uri	body	string	false	none
» client_id	body	string	false	none
» client_secret	body	string	false	none
» code_verifier	body	string	false	none

Example responses

200 Response

{
  "token": "string",
  "expiresAt": "2023-12-03T10:15:30+01:00",
  "id": "string",
  "expiry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» token	string	false	none	The secret token. This is a secret and shall be treated as such.
» expiresAt	string	false	none	The timestamp when the token will expire, expressed as ISO-8601 extended offset date-time format
» id	UUID(uuid)	false	none	The Identity of the token, can be used to manage the token but not use it
» expiry	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

OAuth2 Authorize support

Code samples

# You can also use wget
curl -X POST /api/oauth2/authorize \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/oauth2/authorize

Create an OAuth2 authorization. Expect that the user has got a user grant to make this call. Note that scope and timeout are set at signon. If a user is signedon when the call is made a new signon with correct scope and timeout is expected.

Body parameter

{
  "client_id": "string",
  "state": "string",
  "redirect_uri": "string",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "code_challenge": "string",
  "code_challenge_method": "S256",
  "tokenName": "string",
  "validity": 0,
  "clientIdentifier": "string",
  "redirectURI": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AuthorizationRequest	false	none

Example responses

200 Response

{
  "authorizationCode": "string",
  "clientState": "string",
  "redirectURI": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Representation of the response to a successful OAuth 2 authorize request.

Name	Type	Required	Restrictions	Description
» authorizationCode	string	false	none	After successful authorization, the actual OAuth 2 response consist of a new authorization code.
» clientState	string	false	none	After successful authorization, the actual OAuth 2 response consist of a client state specified in the authorization request.
» redirectURI	string	false	none	A redirectionURI.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Organization

All operations related to organization settings.

Get Organization Policies

Code samples

# You can also use wget
curl -X GET /api/organization \
  -H 'Accept: application/json'

GET /api/organization

Get the Organization Policies for the organization.

Example responses

200 Response

{
  "allowAdminCredentialsAssignment": true,
  "allowExternalUserZoneCreation": true,
  "allowExtraAdministrators": true,
  "allowInternalUsersToSeeNonHiddenUsers": true,
  "autoCreateIDPUsers": true,
  "enforceNewPasswordChange": true,
  "enforceOldPasswordChange": false,
  "idpClientIdentifier": "2c9fbd387b3f9dcb017ba0ea332160ed",
  "idpOrganizationIdentifier": "2c9fbd387b3f9dcb017ba0ea332160ed",
  "idpType": "SecureAppbox",
  "maxNumberOfPersonalZones": 20,
  "maxPersonalZoneSize": 4294967296,
  "minimumPasswordLength": 8,
  "passwordReminderIntervalInDays": 100,
  "passwordTimeoutInDays": 300,
  "personalIdentificationTypes": [
    {
      "description": "BankId",
      "name": "SWEDISH_MOBILE_BANK_ID"
    }
  ],
  "preventClientDataUpload": false,
  "preventServerDataUpload": false,
  "requireAdministratorForZoneCreation": false,
  "signOnPolicy": "PasswordAlways"
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» allowExtraAdministrators	boolean	false	none	This is a setting that permits other users than the main administrator to act as an administrator.
» allowAdminCredentialsAssignment	boolean	false	none	Allow administrators to reset the main administrator credentials.
» preventClientDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text.
» preventServerDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text."
» allowExternalUserZoneCreation	boolean	false	none	If true, external users may create private zones.
» requireAdministratorForZoneCreation	boolean	false	none	If true internal users may not create zones, only administrators may.
» maxPersonalZoneSize	integer(int64)	false	none	The maximum cleartext size for a personal zone.
» maxNumberOfPersonalZones	integer(int32)	false	none	The maximum number of personal zones.
» minimumPasswordLength	integer(int32)	false	none	The minimum password length.
» passwordTimeoutInDays	integer(int64)	false	none	The expiry time for passwords.
» passwordReminderIntervalInDays	integer(int64)	false	none	The frequency for reminding the user to change her password.
» enforceOldPasswordChange	boolean	false	none	If true the user will be forced to change an expired old password.
» enforceNewPasswordChange	boolean	false	none	If true the user will be forced to change a newly generated password with her own password.
» signOnPolicy	SignOn	false	none	The organization sign on policy to be used
» idpType	string	false	none	The type of IDP to use. This can be selected from a list of IDPs that Synkzone currently supports. Currently support is available for ‘None’ and ‘AzureAD’
» idpClientIdentifier	string	false	none	The client identifier registered for your Synkzone organization with the IDP.
» idpOrganizationIdentifier	string	false	none	The identifier for your organization as registered with the IDP.
» personalIdentificationTypes	[PersonalIdentificationTypeData]	false	none	The personalIdentificationTypes used by the organisation.
»» name	string	false	none	The name of the Personal Identification Type
»» description	string	false	none	A description of the Personal Identification Type
»» icon	string(binary)	false	none	An icon that represents the Personal Identification Type
» allowInternalUsersToSeeNonHiddenUsers	boolean	false	none	If true allow internal users to see all other internal users, not only coworkers (users you share zones with).
» autoCreateIDPUsers	boolean	false	none	Determine if previously unknown IDP user identities shall get automatically created Synkzone accounts.
» enableGroups	boolean	false	none	Activate support for Group feature.
» enableTenants	boolean	false	none	Activate support for Tenant feature.
» sspDataFields	[FieldData]	false	none	SSP settings.
»» name	string	false	none	The name of the field, to be presented in forms. This must be a non-empty string. Any leading or trailing white space will be trimmed away.
»» description	string	false	none	Optional free text description of the field, its purpose, etc.,to be used as hint/help when filling in instances of the field.
»» type	FieldContentType	false	none	The type of content intended for this field, which may be used to validate any value entered into the field. This must always be specified.
»» required	boolean	false	none	Specifies if this field must be assigned non-empty value or not.
»» validContents	[string]	false	none	Optional list of values or value patterns that may be entered in this field. If not specified, or empty, any value will be accepted. Otherwise, only values in this list are to be considered valid for this field. May be used in forms to show a selection of valued to choose from. Each value is specified as a regular expression so it is possible to specify not only fixed values, but also value patterns.

Enumerated Values

Property	Value
signOnPolicy	Local
signOnPolicy	ClientVerification
signOnPolicy	PasswordAlways
signOnPolicy	OTP
signOnPolicy	TwoFA
signOnPolicy	IDP
type	General
type	Number
type	Date

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update Organization Policies

Code samples

# You can also use wget
curl -X PUT /api/organization \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/organization

Update the Organization Policies for the organization.

Body parameter

{
  "allowExtraAdministrators": true,
  "allowAdminCredentialsAssignment": false,
  "preventClientDataUpload": false,
  "preventServerDataUpload": false,
  "allowExternalUserZoneCreation": false,
  "requireAdministratorForZoneCreation": false,
  "maxPersonalZoneSize": "107_374_182_400",
  "maxNumberOfPersonalZones": 4,
  "minimumPasswordLength": 8,
  "passwordTimeoutInDays": 1,
  "passwordReminderIntervalInDays": 604800000,
  "enforceOldPasswordChange": false,
  "enforceNewPasswordChange": false,
  "signOnPolicy": "Local",
  "idpType": "None",
  "idpClientIdentifier": "",
  "idpOrganizationIdentifier": "",
  "personalIdentificationTypes": [
    {
      "name": "string",
      "description": "string",
      "icon": "string"
    }
  ],
  "allowInternalUsersToSeeNonHiddenUsers": true,
  "autoCreateIDPUsers": false,
  "enableGroups": false,
  "enableTenants": false,
  "sspDataFields": [
    {
      "name": "string",
      "description": "string",
      "type": "General",
      "required": true,
      "validContents": [
        "string"
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	OrganizationPolicies	false	none

Example responses

200 Response

{
  "allowExtraAdministrators": true,
  "allowAdminCredentialsAssignment": false,
  "preventClientDataUpload": false,
  "preventServerDataUpload": false,
  "allowExternalUserZoneCreation": false,
  "requireAdministratorForZoneCreation": false,
  "maxPersonalZoneSize": "107_374_182_400",
  "maxNumberOfPersonalZones": 4,
  "minimumPasswordLength": 8,
  "passwordTimeoutInDays": 1,
  "passwordReminderIntervalInDays": 604800000,
  "enforceOldPasswordChange": false,
  "enforceNewPasswordChange": false,
  "signOnPolicy": "Local",
  "idpType": "None",
  "idpClientIdentifier": "",
  "idpOrganizationIdentifier": "",
  "personalIdentificationTypes": [
    {
      "name": "string",
      "description": "string",
      "icon": "string"
    }
  ],
  "allowInternalUsersToSeeNonHiddenUsers": true,
  "autoCreateIDPUsers": false,
  "enableGroups": false,
  "enableTenants": false,
  "sspDataFields": [
    {
      "name": "string",
      "description": "string",
      "type": "General",
      "required": true,
      "validContents": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
405	Method Not Allowed	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» allowExtraAdministrators	boolean	false	none	This is a setting that permits other users than the main administrator to act as an administrator.
» allowAdminCredentialsAssignment	boolean	false	none	Allow administrators to reset the main administrator credentials.
» preventClientDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text.
» preventServerDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text."
» allowExternalUserZoneCreation	boolean	false	none	If true, external users may create private zones.
» requireAdministratorForZoneCreation	boolean	false	none	If true internal users may not create zones, only administrators may.
» maxPersonalZoneSize	integer(int64)	false	none	The maximum cleartext size for a personal zone.
» maxNumberOfPersonalZones	integer(int32)	false	none	The maximum number of personal zones.
» minimumPasswordLength	integer(int32)	false	none	The minimum password length.
» passwordTimeoutInDays	integer(int64)	false	none	The expiry time for passwords.
» passwordReminderIntervalInDays	integer(int64)	false	none	The frequency for reminding the user to change her password.
» enforceOldPasswordChange	boolean	false	none	If true the user will be forced to change an expired old password.
» enforceNewPasswordChange	boolean	false	none	If true the user will be forced to change a newly generated password with her own password.
» signOnPolicy	SignOn	false	none	The organization sign on policy to be used
» idpType	string	false	none	The type of IDP to use. This can be selected from a list of IDPs that Synkzone currently supports. Currently support is available for ‘None’ and ‘AzureAD’
» idpClientIdentifier	string	false	none	The client identifier registered for your Synkzone organization with the IDP.
» idpOrganizationIdentifier	string	false	none	The identifier for your organization as registered with the IDP.
» personalIdentificationTypes	[PersonalIdentificationTypeData]	false	none	The personalIdentificationTypes used by the organisation.
»» name	string	false	none	The name of the Personal Identification Type
»» description	string	false	none	A description of the Personal Identification Type
»» icon	string(binary)	false	none	An icon that represents the Personal Identification Type
» allowInternalUsersToSeeNonHiddenUsers	boolean	false	none	If true allow internal users to see all other internal users, not only coworkers (users you share zones with).
» autoCreateIDPUsers	boolean	false	none	Determine if previously unknown IDP user identities shall get automatically created Synkzone accounts.
» enableGroups	boolean	false	none	Activate support for Group feature.
» enableTenants	boolean	false	none	Activate support for Tenant feature.
» sspDataFields	[FieldData]	false	none	SSP settings.
»» name	string	false	none	The name of the field, to be presented in forms. This must be a non-empty string. Any leading or trailing white space will be trimmed away.
»» description	string	false	none	Optional free text description of the field, its purpose, etc.,to be used as hint/help when filling in instances of the field.
»» type	FieldContentType	false	none	The type of content intended for this field, which may be used to validate any value entered into the field. This must always be specified.
»» required	boolean	false	none	Specifies if this field must be assigned non-empty value or not.
»» validContents	[string]	false	none	Optional list of values or value patterns that may be entered in this field. If not specified, or empty, any value will be accepted. Otherwise, only values in this list are to be considered valid for this field. May be used in forms to show a selection of valued to choose from. Each value is specified as a regular expression so it is possible to specify not only fixed values, but also value patterns.

Enumerated Values

Property	Value
signOnPolicy	Local
signOnPolicy	ClientVerification
signOnPolicy	PasswordAlways
signOnPolicy	OTP
signOnPolicy	TwoFA
signOnPolicy	IDP
type	General
type	Number
type	Date

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get Organization Data

Code samples

# You can also use wget
curl -X GET /api/organization/data \
  -H 'Accept: application/json'

GET /api/organization/data

Get the Organization Data for the organization.

Example responses

200 Response

{
  "created": "2022-12-13T15:29:54.445+01:00",
  "name": "example.org",
  "ssiServiceAddress": "api.example.org",
  "synkerUpdateURL": "update.example.org",
  "webServiceAddress": "web.example.org"
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
405	Method Not Allowed	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	false	none	The name (Unique identifier) of the organization
» created	string	false	none	The creation timestamp of the organization as ISO-8601 extended offset date-time format
» webServiceAddress	string	false	none	The host address of the web service if such exists
» ssiServiceAddress	string	false	none	The host address of the SSI (API) service if such exists
» synkerUpdateURL	string	false	none	The address where client updates are distributed
» displayName	string	false	none	Optional name to use instead of the identifier when displaying or referring the organization in end user interaction
» iconURI	string	false	none	Optional specification for how and where to get logos and/or other icons to use when displaying the organization in end user interaction
» signOnInfo	string	false	none	Optional information to shown to users who attempt to sign on to the organization, such as specific instructions or legal information
» status	OrganizationStatus	false	none	Representation of the current status of an organization: Registered: The organization has registered settings within its world, so it should be ready to access. Unregistered: No registered settings for the organization can be found, so may be either removed or waiting to be registered.

Enumerated Values

Property	Value
status	Registered
status	Unregistered

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get Selectable IDPs

Code samples

# You can also use wget
curl -X GET /api/organization/idps \
  -H 'Accept: application/json'

GET /api/organization/idps

Get a list of selectable Identity Providers)

Example responses

200 Response

{
  "selectableIDPs": [
    "None",
    "AzureAD"
  ]
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» selectableIDPs	[string]	false	none	An array of selectable IDP names.

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create (Upload) a resource in a multipart body

Code samples

# You can also use wget
curl -X POST /api/organization/resource/{resourceid} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json'

POST /api/organization/resource/{resourceid}

Uploads a new resource file.

Body parameter

file: string
fileName: string

Parameters

Name	In	Type	Required	Description
resourceid	path	string	true	The identity of the resource. Example: ‘organization-logotype’, ‘avatar’, …
store-timeout	query	integer(int64)	false	If > 0, how long (ms) to wait for the file to become globally stored, if exceeded, the request fails with 408 Request Timeout (and the upload will be reversed). If set to 0, the operation will return after registration but does not provide a guarantee that the file has been globally stored at this point.
tag	query	string	false	If provided a specific tag (URLEncoded) to select the specific resource if several are available for this id.
userid	query	string	false	If provided a specific UserId (URLEncoded) to identify the specific resource if several are available for this id.
body	body	object	false	none
» file	body	string(binary)	false	The contents of the file expressed as an inputStream
» fileName	body	string	false	The name of the file

Enumerated Values

Parameter	Value
resourceid	organization-logotype
resourceid	avatar
resourceid	color-themes
resourceid	favorite-zones

Example responses

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

404 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

408 Response

{
  "error": "TIMEOUT",
  "message": "File upload time out"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
408	Request Timeout	Request Timeout	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete resource key

Code samples

# You can also use wget
curl -X DELETE /api/organization/resource/{resourceid} \
  -H 'Accept: application/json'

DELETE /api/organization/resource/{resourceid}

Delete a system resource.

Parameters

Name	In	Type	Required	Description
resourceid	path	string	true	The identity of the resource to get.
tag	query	string	false	If provided a specific tag (URLEncoded) to select the specific resource if several are available for this id.
userid	query	string	false	If provided a specific UserId (URLEncoded) to select the specific resource if several are available for this id.

Enumerated Values

Parameter	Value
resourceid	organization-logotype
resourceid	avatar
resourceid	color-themes
resourceid	favorite-zones

Example responses

200 Response

true

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	boolean
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not found, the specific key was not removed	None

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get resource contents

Code samples

# You can also use wget
curl -X HEAD /api/organization/resource/{resourceid}/content \
  -H 'Accept: image/png' \
  -H 'Range: string'

HEAD /api/organization/resource/{resourceid}/content

Get a system resource (example: ‘organization-logotype’, ‘avatar’, ‘color-themes’ …) that is shared within the organization.

Parameters

Name	In	Type	Required	Description
resourceid	path	string	true	The identity of the resource to get.
download	query	boolean	false	(DEPRECATED, Use parameter useInline instead.)If true return with ‘Content-Disposition’ header set to attachement, forcing browser/client to download.
tag	query	string	false	If provided a specific tag (URLEncoded) to select the specific resource if several are available for this id.
useInline	query	boolean	false	Determines the Content-Disposition header behavior for the response. When set to true, the header Content-Disposition: inline is applied, causing the content to be displayed directly in the browser (if supported). When set to false (default), the header Content-Disposition: attachment is applied, prompting the browser to download the content.
userid	query	string	false	If provided a specific UserId (URLEncoded) to select the specific resource if several are available for this id.
Range	header	string	false	An optional range indicating the part of a document that the server should return.

Enumerated Values

Parameter	Value
resourceid	organization-logotype
resourceid	avatar
resourceid	color-themes
resourceid	favorite-zones

Example responses

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	None
206	Partial Content	Partial Content returned	None
400	Bad Request	Internal error or content read error	None
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not found	None

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Response Headers

Status	Header	Type	Format	Description
200	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
200	Content-Type	undefined		The MIME type of the returned content.
200	Content-Length	undefined		The size of the content in the current range.
200	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.
200	Cache-Control	undefined		Indicates caching directives for the response. For example, public, max-age=3000 means the response can be cached by any browser for 3000 seconds.
200	ETag	undefined		A unique identifier for a specific version of the resource. Useful for caching and conditional requests.
200	Last-Modified	undefined		The timestamp of the last modification to the resource.
206	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
206	Content-Type	undefined		The MIME type of the returned content.
206	Content-Length	undefined		The size of the content in the current range.
206	Content-Range	undefined		The range of bytes returned in the response.
206	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.
206	Cache-Control	undefined		Indicates caching directives for the response. For example, public, max-age=3000 means the response can be cached by any browser for 3000 seconds.
206	ETag	undefined		A unique identifier for a specific version of the resource. Useful for caching and conditional requests.
206	Last-Modified	undefined		The timestamp of the last modification to the resource.

Create (Upload) file as stream

Code samples

# You can also use wget
curl -X POST /api/organization/resource/{resourceid}/stream?filename=string \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json'

POST /api/organization/resource/{resourceid}/stream

Uploads a stream of data as a unique name to the given zone.

Body parameter

string

Parameters

Name	In	Type	Required	Description
resourceid	path	string	true	The identity of the resource. Example ‘organization-logotype’, ‘avatar’, …
filename	query	string	true	A filename with a file extension so the file type can be determined.
store-timeout	query	integer(int64)	false	If > 0, how long (ms) to wait for the file to become globally stored, if exceeded, the request fails with 408 Request Timeout (and the upload will be reversed). If set to 0, the operation will return after registration but does not provide a guarantee that the file has been globally stored at this point.
tag	query	string	false	If provided a specific tag (URLEncoded) to select the specific resource if several are available for this id.
userid	query	string	false	If provided a specific UserId (URLEncoded) to identify the specific resource if several are available for this id.
body	body	string(binary)	false	none

Enumerated Values

Parameter	Value
resourceid	organization-logotype
resourceid	avatar
resourceid	color-themes
resourceid	favorite-zones

Example responses

201 Response

{
  "id": "string",
  "tag": "string",
  "userId": {
    "id": "string",
    "name": "string",
    "group": true
  }
}

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "Illegal fileid"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

408 Response

{
  "error": "TIMEOUT",
  "message": "File upload time out"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
408	Request Timeout	Request Timeout	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» id	string	false	none	none
» tag	string	false	none	none
» userId	UserId1	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» group	boolean	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

List resource keys

Code samples

# You can also use wget
curl -X GET /api/organization/resources \
  -H 'Accept: application/json'

GET /api/organization/resources

List system resources (example logotype, avatars, template…) that are shared within the organization.

Parameters

Name	In	Type	Required	Description
resourceid	query	string	false	The identity of the resource to get.
tag	query	string	false	If provided a specific tag (URLEncoded) to select the specific resource if several are available for this id.
userid	query	string	false	If provided a specific UserId (URLEncoded) to select the specific resource if several are available for this id.

Example responses

200 Response

[
  {
    "id": "avatar",
    "userId": {
      "name": "test1@dev"
    }
  },
  {
    "id": "avatar",
    "tag": "",
    "userId": {
      "name": "test2@dev"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none
» tag	string	false	none	none
» userId	UserId1	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» group	boolean	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

PlatformNotifications

Handle notifications from platform to user.

Pull next platform notification

Code samples

# You can also use wget
curl -X GET /api/notification \
  -H 'Accept: application/json'

GET /api/notification

Get up to ‘numOfEntries’ PlatformNotification from the queue.

Parameters

Name	In	Type	Required	Description
numOfEntries	query	integer	false	Max number of entries to return

Example responses

200 Response

[
  {
    "subject": "string",
    "data": {
      "createdAt": "string",
      "id": 0,
      "userId": "string",
      "zoneId": "string",
      "messageTypeId": "string",
      "title": "string",
      "message": "string",
      "timeout": 0,
      "defaultResponse": true,
      "assignedPassword": [
        "string"
      ]
    }
  }
]

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PlatformNotification]	false	none	none
» subject	string	false	none	The subject
» data	MessageData	false	none	The MessageData
»» createdAt	string	false	none	Timestamp in the local platform time when the message was created
»» id	integer(int64)	false	none	A unique ID for this particular event.
»» userId	string	false	none	The userId.
»» zoneId	UUID(uuid)	false	none	The zoneId.
»» messageTypeId	string	false	none	A unique name for the type of message, which may be used to match the request to already prepared responses.
»» title	string	false	none	A message title which for example can be used as a dialog title or other header The title text is translated to the user’spreferred language (if translations exist).
»» message	string	false	none	The message text, translated to the user’s preferred language (if translations exist).
»» timeout	integer(int64)	false	none	Maximum time in milliseconds to wait for a response, Zero or negative means to wait indefinitely
»» defaultResponse	boolean	false	none	A default Response
»» assignedPassword	[string]	false	none	The assigned Password, note: used only under specific circumstances

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Confirm notification

Code samples

# You can also use wget
curl -X POST /api/notification \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/notification

Respond to a specific confirmation dialogue.

Body parameter

{
  "id": 0,
  "response": true
}

Parameters

Name	In	Type	Required	Description
body	body	ConfirmNotification	false	none

Example responses

204 Response

[
  {
    "subject": "string",
    "data": {
      "createdAt": "string",
      "id": 0,
      "userId": "string",
      "zoneId": "string",
      "messageTypeId": "string",
      "title": "string",
      "message": "string",
      "timeout": 0,
      "defaultResponse": true,
      "assignedPassword": [
        "string"
      ]
    }
  }
]

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 204

Name	Type	Required	Restrictions	Description
anonymous	[PlatformNotification]	false	none	none
» subject	string	false	none	The subject
» data	MessageData	false	none	The MessageData
»» createdAt	string	false	none	Timestamp in the local platform time when the message was created
»» id	integer(int64)	false	none	A unique ID for this particular event.
»» userId	string	false	none	The userId.
»» zoneId	UUID(uuid)	false	none	The zoneId.
»» messageTypeId	string	false	none	A unique name for the type of message, which may be used to match the request to already prepared responses.
»» title	string	false	none	A message title which for example can be used as a dialog title or other header The title text is translated to the user’spreferred language (if translations exist).
»» message	string	false	none	The message text, translated to the user’s preferred language (if translations exist).
»» timeout	integer(int64)	false	none	Maximum time in milliseconds to wait for a response, Zero or negative means to wait indefinitely
»» defaultResponse	boolean	false	none	A default Response
»» assignedPassword	[string]	false	none	The assigned Password, note: used only under specific circumstances

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Share (Manage)

All share operations. A share is a way to provide a resource (e.g. a download or upload) to a recipient.

List shares

Code samples

# You can also use wget
curl -X GET /api/share/manage/{zoneid} \
  -H 'Accept: application/json'

GET /api/share/manage/{zoneid}

Lists all shares in a zone.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
page	query	integer	false	Pagination. The number of entries on a page
pageSize	query	integer(int32)	false	none

Example responses

200 Response

[
  {
    "createdAt": "2025-01-02T08:52:12.841+01:00",
    "name": "Share latest proposal",
    "shareID": "15ECFC9088201A5EEB90163340AD02FD535DA6C1BE59155689BD04C4C0D733DF",
    "state": "OK",
    "usageReport": [
      {
        "fileId": "8703821F1BB74B10A78615D611965DC41F80A7640000018D17B6C5B21A45590A",
        "timeStamp": "2025-01-02T11:50:56.002+01:00",
        "type": "download"
      }
    ],
    "userId": {
      "name": "billy@example.com"
    },
    "validFrom": "2025-01-02T08:53:12.838+01:00",
    "validUntil": "2025-04-20T13:11:24.316+02:00"
  }
]

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ShareInformation]	false	none	[Basic Information about the share.]
» shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
» name	string	false	none	The (non secret) name of the share that is used for display and manage purposes.
» link	string	false	none	The secret link created that is to be provided to the recipient. This link is only available if the share accepts anonymous users.
» createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
» validFrom	string	false	none	The timestamp when the share will start to be valid. (ISO-8601 extended offset date-time format).
» validUntil	string	false	none	The validity of the share (ISO-8601 extended offset date-time format).
» userId	UserId	false	none	The creator of the share.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.
» state	ShareState	false	none	The state of the share.
» usageReport	[UsageReport]	false	none	Information about how the share has been used e.g. download/upload.
»» user	string	false	none	The user, empty is anonymous.
»» ipHeader	string	false	none	The ip address of the (recipient) user.
»» fileId	string	false	none	The fileid of the up or downloaded file.
»» versionTimeStamp	string	false	none	The version timestamp (created) of the fileid, expressed as ISO-8601 extended offset date-time format.
»» type	string	false	none	The type of resource utilization, e.g. download or upload.
»» timeStamp	string	false	none	The timestamp of the resource usage, in ISO-8601 extended offset date-time format.
» shareAuthorizationType	ShareAuthorizationType1	false	none	The required authorization to access as a recipient of this share.
» protectionType	ProtectionType	false	none	The required protection type to access as a recipient of this share.
» recipients	[string]	false	none	A list of e-mail adresses (or other valid identifier used in the authorization process) to identify the recipients of this share.
» spScope	SPScope	false	none	The shared resource expressed as a scope (May not be available when listing ShareInformation).
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» messageText	string	false	none	A message text attached to the share that is displayed for the recipient. If the share information is sent by an e-mail this information may be included.
» shareURI	string	false	none	The complete URI of the Shared Resource to be used by the recipient (not always available when retrieving the share).
» errorMessage	string	false	none	A description of an error if such exists.

Enumerated Values

Property	Value
state	OK
state	Pending
state	Cancelled
state	Broken
state	CreationFailure
state	ResourceDepleted
state	Creating
state	Expired
shareAuthorizationType	none
shareAuthorizationType	userAndPassword
shareAuthorizationType	userAndAuth
protectionType	PASSWORD
protectionType	NONE

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create a shared resource

Code samples

# You can also use wget
curl -X POST /api/share/manage/{zoneid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/share/manage/{zoneid}

Create a shared resource.

Body parameter

{
  "name": "string",
  "validUntil": "2011-12-05T10:15:30+01:00",
  "validFrom": "2011-12-03T10:15:30+01:00",
  "scope": {
    "clients": [
      "SynkzoneWeb"
    ],
    "name": "scopename",
    "description": "access a file",
    "permissions": {
      "Zone=a96ddc43-e050-47f3-97eb-d80dfcd8deea": {
        "all": true
      },
      "ZoneFile=B79542DAB6D64F1682F530F9C9AA7E36EC167F9C0000018016E7963799053C10": {
        "list": true,
        "get": true,
        "access": true,
        "modify": true
      }
    }
  },
  "messageText": "Hi, here is the latest account statement.",
  "shareURI": "https://www.example.com:123/sharedlinks/{sharekey}/download",
  "password": [
    "a",
    "b",
    "c",
    "1"
  ],
  "shareAuthorization": {
    "myType": "userAndPassword",
    "userAndAuth": [
      {
        "shareRecipient": {
          "displayName": "christer",
          "userName": "christer@example.com",
          "internalIdentifier": "abc123",
          "shareInformationRecipientIdentifierType": "none",
          "shareInformationRecipientIdentifier": ""
        },
        "shareRecipientAuthorization": {
          "shareRecipientAuthorizationType": "password",
          "shareRecipientAuthorization": "aSecretPassword!"
        }
      }
    ]
  },
  "shareProtection": {
    "type": "PASSWORD",
    "password": [
      "p",
      "a",
      "s",
      "s",
      "w",
      "o",
      "r",
      "d"
    ]
  },
  "maxNumberOfOperations": -1
}

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
body	body	SharedResourceIndata	false	none

Example responses

201 Response

[
  {
    "sharekey": "B0A7A4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A77C1",
    "shareid": "A0A1B4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A66C2",
    "shareURI": "https://www.example.org/share/B0A7A4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A77C1"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[SharedResourceCreateResult]	false	none	none
» sharekey	string	false	none	The (secret) of the shared resource, this secret shall be appended with protocol + host and provided to the recipient of the share
» shareid	string	false	none	The (non secret) id of the shared resource, that can be used to manage the share
» shareURI	string	false	none	The URi of the share, to be provided to the recipient

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get shared content data

Code samples

# You can also use wget
curl -X GET /api/share/manage/{zoneid}/{shareid} \
  -H 'Accept: application/json'

GET /api/share/manage/{zoneid}/{shareid}

Get information about a share in order to manage the share.

Parameters

Name	In	Type	Required	Description
shareid	path	string	true	The identity of the shared resource.
zoneid	path	UUID	true	none

Example responses

200 Response

{
  "createdAt": "2025-01-02T13:37:30.163+01:00",
  "messageText": "here is the file (password protected)",
  "name": "Share latest proposal",
  "shareID": "15ECFC9088201A5EEB90163340AD02FD535DA6C1BE59155689BD04C4C0D733DF",
  "shareURI": "https:://example.com/A4E42C2992F91F8948C6A7F3E86EB725955AD3A17D06FDCA6CA0F94E45AA22CD",
  "spScope": {
    "clients": [
      "SynkzoneWeb"
    ],
    "description": "access a file",
    "limitations": {
      "ClientSynkzoneWeb": true
    },
    "name": "scopename",
    "permissions": {
      "Zone=3c4207c5-5d4c-42cc-a2c5-745c7a06aada": {
        "access": true,
        "all": true,
        "create": true,
        "delete": true,
        "get": true,
        "list": true,
        "modify": true
      },
      "ZoneFile=8703821F1BB74B10A78615D611965DC41F80A7640000018D17B6C5B21A45590A": {
        "access": true,
        "all": false,
        "create": false,
        "delete": false,
        "get": true,
        "list": true,
        "modify": true
      }
    }
  },
  "state": "OK",
  "usageReport": [],
  "userId": {
    "name": "bobby@example.com"
  },
  "validFrom": "2025-01-02T13:38:27.365+01:00",
  "validUntil": "2025-04-20T13:11:24.316+02:00"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	None
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Basic Information about the share.

Name	Type	Required	Restrictions	Description
» shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
» name	string	false	none	The (non secret) name of the share that is used for display and manage purposes.
» link	string	false	none	The secret link created that is to be provided to the recipient. This link is only available if the share accepts anonymous users.
» createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
» validFrom	string	false	none	The timestamp when the share will start to be valid. (ISO-8601 extended offset date-time format).
» validUntil	string	false	none	The validity of the share (ISO-8601 extended offset date-time format).
» userId	UserId	false	none	The creator of the share.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.
» state	ShareState	false	none	The state of the share.
» usageReport	[UsageReport]	false	none	Information about how the share has been used e.g. download/upload.
»» user	string	false	none	The user, empty is anonymous.
»» ipHeader	string	false	none	The ip address of the (recipient) user.
»» fileId	string	false	none	The fileid of the up or downloaded file.
»» versionTimeStamp	string	false	none	The version timestamp (created) of the fileid, expressed as ISO-8601 extended offset date-time format.
»» type	string	false	none	The type of resource utilization, e.g. download or upload.
»» timeStamp	string	false	none	The timestamp of the resource usage, in ISO-8601 extended offset date-time format.
» shareAuthorizationType	ShareAuthorizationType1	false	none	The required authorization to access as a recipient of this share.
» protectionType	ProtectionType	false	none	The required protection type to access as a recipient of this share.
» recipients	[string]	false	none	A list of e-mail adresses (or other valid identifier used in the authorization process) to identify the recipients of this share.
» spScope	SPScope	false	none	The shared resource expressed as a scope (May not be available when listing ShareInformation).
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» messageText	string	false	none	A message text attached to the share that is displayed for the recipient. If the share information is sent by an e-mail this information may be included.
» shareURI	string	false	none	The complete URI of the Shared Resource to be used by the recipient (not always available when retrieving the share).
» errorMessage	string	false	none	A description of an error if such exists.

Enumerated Values

Property	Value
state	OK
state	Pending
state	Cancelled
state	Broken
state	CreationFailure
state	ResourceDepleted
state	Creating
state	Expired
shareAuthorizationType	none
shareAuthorizationType	userAndPassword
shareAuthorizationType	userAndAuth
protectionType	PASSWORD
protectionType	NONE

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Cancel share

Code samples

# You can also use wget
curl -X DELETE /api/share/manage/{zoneid}/{shareid} \
  -H 'Accept: application/json'

DELETE /api/share/manage/{zoneid}/{shareid}

Cancel a specific share in a zone.

Parameters

Name	In	Type	Required	Description
shareid	path	string	true	The identity of the shared resource.
zoneid	path	UUID	true	none

Example responses

200 Response

{
  "shareID": "string",
  "name": "string",
  "link": "string",
  "createdAt": "2011-12-03T10:15:30+01:00",
  "validFrom": "2011-12-03T10:15:30+01:00",
  "validUntil": "2011-12-05T10:15:30+01:00",
  "userId": {
    "name": "bob@example.com"
  },
  "state": "OK",
  "usageReport": [
    {
      "user": "chris@example.com",
      "ipHeader": "212.193.12.123",
      "fileId": "B79542DAB6D64F1682F530F9C9AA7E36EC167F9C0000018016E7963799053C10",
      "versionTimeStamp": "2023-04-11T18:06:12.056+02:00",
      "type": "download",
      "timeStamp": "2011-12-03T10:15:30+01:00"
    }
  ],
  "shareAuthorizationType": "none",
  "protectionType": "PASSWORD",
  "recipients": [
    "string"
  ],
  "spScope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "messageText": "string",
  "shareURI": "string",
  "errorMessage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	None

Response Schema

Status Code 200

Basic Information about the share.

Name	Type	Required	Restrictions	Description
» shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
» name	string	false	none	The (non secret) name of the share that is used for display and manage purposes.
» link	string	false	none	The secret link created that is to be provided to the recipient. This link is only available if the share accepts anonymous users.
» createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
» validFrom	string	false	none	The timestamp when the share will start to be valid. (ISO-8601 extended offset date-time format).
» validUntil	string	false	none	The validity of the share (ISO-8601 extended offset date-time format).
» userId	UserId	false	none	The creator of the share.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.
» state	ShareState	false	none	The state of the share.
» usageReport	[UsageReport]	false	none	Information about how the share has been used e.g. download/upload.
»» user	string	false	none	The user, empty is anonymous.
»» ipHeader	string	false	none	The ip address of the (recipient) user.
»» fileId	string	false	none	The fileid of the up or downloaded file.
»» versionTimeStamp	string	false	none	The version timestamp (created) of the fileid, expressed as ISO-8601 extended offset date-time format.
»» type	string	false	none	The type of resource utilization, e.g. download or upload.
»» timeStamp	string	false	none	The timestamp of the resource usage, in ISO-8601 extended offset date-time format.
» shareAuthorizationType	ShareAuthorizationType1	false	none	The required authorization to access as a recipient of this share.
» protectionType	ProtectionType	false	none	The required protection type to access as a recipient of this share.
» recipients	[string]	false	none	A list of e-mail adresses (or other valid identifier used in the authorization process) to identify the recipients of this share.
» spScope	SPScope	false	none	The shared resource expressed as a scope (May not be available when listing ShareInformation).
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» messageText	string	false	none	A message text attached to the share that is displayed for the recipient. If the share information is sent by an e-mail this information may be included.
» shareURI	string	false	none	The complete URI of the Shared Resource to be used by the recipient (not always available when retrieving the share).
» errorMessage	string	false	none	A description of an error if such exists.

Enumerated Values

Property	Value
state	OK
state	Pending
state	Cancelled
state	Broken
state	CreationFailure
state	ResourceDepleted
state	Creating
state	Expired
shareAuthorizationType	none
shareAuthorizationType	userAndPassword
shareAuthorizationType	userAndAuth
protectionType	PASSWORD
protectionType	NONE

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Share (Recipient)

All share operations from a recipient point of view.

Get share data

Code samples

# You can also use wget
curl -X GET /api/public/share/{sharekey} \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

GET /api/public/share/{sharekey}

Provide general info about the share to a recipient.

Parameters

Name	In	Type	Required	Description
sharekey	path	string	true	The (secret) link provided to the recipient.
authorization	query	string	false	See description for Authorization
X-Real-Ip	header	string	false	none

Example responses

200 Response

{
  "createdAt": "2023-06-26T12:11:15.569+02:00",
  "maxNumOfOperations": -1,
  "message": "Here is the file",
  "shareAuthorizationType": "none",
  "shareID": "A64B8267E83FF1508FC7BC5562087011810CDBEA4959E1717864A652BD5B7605",
  "sharedResource": {
    "clients": [
      "SynkzoneWeb"
    ],
    "description": "access a file",
    "limitations": {
      "ClientSynkzoneWeb": true
    },
    "name": "scopename",
    "permissions": {
      "Zone=138536d4-1e56-4fbc-b084-b6caabfe66a6": {
        "access": true,
        "all": true,
        "create": true,
        "delete": true,
        "get": true,
        "list": true,
        "modify": true
      },
      "ZoneFile=00000000000000000000000000000001663A7C92000001861747B71892636375": {
        "access": true,
        "all": false,
        "create": false,
        "delete": false,
        "get": true,
        "list": true,
        "modify": true
      }
    }
  },
  "state": "OK",
  "userId": {
    "name": "chris@example.com"
  },
  "validFrom": "2023-06-26T12:11:15.569+02:00",
  "validUntil": "2023-06-29T10:29:21.428+02:00"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	None
406	Not Acceptable	Not Acceptable	Inline
409	Conflict	Conflict, the resource is not YET valid	Inline
410	Gone	Gone, the resource has expired permanently	None

Response Schema

Status Code 200

Detailed Information about the share.

Name	Type	Required	Restrictions	Description
» shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
» createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
» validFrom	string	false	none	The timestamp when the share will start to be valid (ISO-8601 extended offset date-time format).
» validUntil	string	false	none	The validity of the share from the ‘validFrom’ timestamp to this ‘validUntil’ expressed as a ISO-8601 extended offset date-time format.
» userId	UserId	false	none	The creator of the share.
»» name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.
» state	ShareState	false	none	The state of the share.
» shareAuthorizationType	ShareAuthorizationType	false	none	The required authorization to access as a recipient of this share.
» shareProtectionType	ProtectionType	false	none	The share protection type if the share is protected.
» sharedResource	SPScope	false	none	The shared resource.
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» message	string	false	none	A message to be displayed to the recipient of the share, describing the content of the share.
» maxNumOfOperations	integer(int32)	false	none	The max num of operations allowed for this share (e.g. download/upload not view fileinfo). If set to negative no restrictions exists.
» errorMessage	string	false	none	An error message explaining why the share has failed (if it has failed).

Enumerated Values

Property	Value
state	OK
state	Pending
state	Cancelled
state	Broken
state	CreationFailure
state	ResourceDepleted
state	Creating
state	Expired
shareAuthorizationType	none
shareAuthorizationType	userAndPassword
shareAuthorizationType	userAndAuth
shareProtectionType	PASSWORD
shareProtectionType	NONE

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Response Headers

Status	Header	Type	Format	Description
200	Set-Cookie	string		Session cookie containing the authorization if request contained a valid authorization provided in authorization header and request contained setcookie=true.

Get the share protection

Code samples

# You can also use wget
curl -X GET /api/public/share/{sharekey}/authorizationrequirements \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

GET /api/public/share/{sharekey}/authorizationrequirements

Get the ‘ProtectionType’ used in this share (does not require authorization).

Parameters

Name	In	Type	Required	Description
sharekey	path	string	true	The (secret) link provided to the recipient.
X-Real-Ip	header	string	false	none

Example responses

200 Response

{
  "protectionType": "PASSWORD"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
404	Not Found	Not Found	None

Response Schema

Status Code 200

Base class for protected shares. Specific protections will need to subclass ShareProtectionDto, e.g. PasswordShareProtectionDto

Name	Type	Required	Restrictions	Description
» type	ProtectionType	false	none	The type of protection, NONE is default

Enumerated Values

Property	Value
type	PASSWORD
type	NONE

Download shared content data

Code samples

# You can also use wget
curl -X HEAD /api/public/share/{sharekey}/download/{fileid} \
  -H 'Accept: image/png' \
  -H 'Range: bytes=0-999' \
  -H 'X-Real-Ip: string'

HEAD /api/public/share/{sharekey}/download/{fileid}

Download a shared file.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file.
sharekey	path	string	true	The (secret) link provided to the recipient.
authorization	query	string	false	See description for Authorization
useInline	query	boolean	false	When true, the content is displayed directly in the browser (if supported). Defaults to false, which serves the content as an attachment.
version	query	integer	false	The version to use, current version is zero. Please consider using versiontimestamp instead since it specifies an exact version. NOTE: Use either version OR versiontimestamp. If neither is supplied current version is used.
versiontimestamp	query	string	false	The version to use specified as a ISO8601 timestamp. NOTE: Use either version OR versiontimestamp.
Range	header	string	false	An optional range indicating the part of a document that the server should return.
X-Real-Ip	header	string	false	none

Example responses

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	None
206	Partial Content	Partial Content returned	None
401	Unauthorized	Unauthorized (resource protected by authorization)	Inline
404	Not Found	Not Found	None
406	Not Acceptable	Not Acceptable (Resource constraint depleted)	Inline
409	Conflict	Conflict, the resource is not YET valid	Inline
410	Gone	Gone, the resource has expired permanently	None

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Response Headers

Status	Header	Type	Format	Description
200	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
200	Content-Type	undefined		The MIME type of the returned content.
200	Content-Length	undefined		The size of the content in the current range.
200	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.
206	Content-Disposition	undefined		Specifies whether the content is displayed inline or as attachement.
206	Content-Type	undefined		The MIME type of the returned content.
206	Content-Length	undefined		The size of the content in the current range.
206	Content-Range	undefined		The range of bytes returned in the response.
206	Accept-Ranges	undefined		Indicates support for range requests, typically bytes.

Get file information

Code samples

# You can also use wget
curl -X GET /api/public/share/{sharekey}/files/{fileid} \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

GET /api/public/share/{sharekey}/files/{fileid}

Retrieve info about a shared file.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file.
sharekey	path	string	true	The (secret) link provided to the recipient.
authorization	query	string	false	See description for Authorization
page	query	integer	false	Pagination. The number of entries on a page
pageSize	query	integer(int32)	false	none
X-Real-Ip	header	string	false	none

Example responses

200 Response

[
  {
    "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600",
    "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
    "name": "hello.txt",
    "properName": "hello",
    "displayName": "hello.txt",
    "type": "TXT",
    "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
    "folder": true,
    "deleted": true,
    "size": 0,
    "lastModified": "2011-12-03T10:15:30+01:00",
    "lastModifiedBy": "bob@example.com",
    "attributes": {
      "writeProtected": false,
      "readProtected": false,
      "executable": false,
      "hidden": false,
      "synchronize": true
    },
    "lockedBy": "string",
    "synchronizationStatus": "Unknown",
    "availableActions": {
      "open": true,
      "openConflict": true,
      "showConflict": true,
      "removeConflict": true,
      "useConflicting": true,
      "browse": true,
      "copyPath": true,
      "lock": true,
      "unlock": true,
      "writeProtect": true,
      "writeEnable": true,
      "readProtect": true,
      "readEnable": true,
      "exclude": true,
      "include": true,
      "restore": true,
      "download": true,
      "upload": true,
      "archive": true,
      "cut": true,
      "copy": true,
      "paste": true,
      "newFolder": true,
      "rename": true,
      "delete": true,
      "permanentDelete": true,
      "webLink": true,
      "showLog": true,
      "downloadAuthenticationTimeout": 0,
      "newFile": true,
      "update": true
    },
    "zoneFileDownloadStatus": {
      "percentDownloaded": 0,
      "averageDownloadSpeed": 0,
      "estimatedRemainingDownloadTime": 0
    },
    "lastChanged": "2011-12-03T10:15:30+01:00",
    "firstChanged": "2011-12-03T10:15:30+01:00",
    "metadataMap": "2011-12-03T10:15:30+01:00"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK. Return an array with one or more (depends if requested file is a folder) ZoneFileData that can be accessed in this share	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	None
406	Not Acceptable	Not Acceptable	Inline
409	Conflict	Conflict, the resource is not YET valid	Inline
410	Gone	Gone, the resource has expired permanently	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneFileData]	false	none	[Data related to a file or a folder.]
» zoneId	UUID(uuid)	false	none	The zoneId of the zone
» id	string	false	none	The zoneFileId of a file
» name	string	false	none	Actual name of the file as used to identify it in the file system
» properName	string	false	none	The file’s name without suffix
» displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
» type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
» parentId	string	false	none	The zoneFileId of the parent
» folder	boolean	false	none	True if folder and not a file
» deleted	boolean	false	none	True if deleted
» size	integer(int64)	false	none	The size of the file
» lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
» lastModifiedBy	string	false	none	The userId of the user that last modified the file
» attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
»» writeProtected	boolean	false	none	true if zoneFile is write protected
»» readProtected	boolean	false	none	true if zoneFile is read protected
»» executable	boolean	false	none	true if zoneFile is executable
»» hidden	boolean	false	none	true if zoneFile is write hidden
»» synchronize	boolean	false	none	true if zoneFile is set to synchronize
» lockedBy	string	false	none	The userId of the user who locked the file, if locked
» synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
» availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
»» open	boolean	false	none	If true the file may be opened
»» openConflict	boolean	false	none	If true the corresponding conflict file may be opened
»» showConflict	boolean	false	none	If true the show the corresponding conflict file
»» removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
»» useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
»» browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
»» copyPath	boolean	false	none	If true the path may be copied to clipboard
»» lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
»» unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
»» writeProtect	boolean	false	none	If true, a write protect is possible to set
»» writeEnable	boolean	false	none	If true, write protect is possible to remove
»» readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
»» readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
»» exclude	boolean	false	none	If true, the file can be excluded from file synchronization
»» include	boolean	false	none	If true, the file can be included in file synchronization
»» restore	boolean	false	none	If true, the file may be restored
»» download	boolean	false	none	If true, the file may be downloaded
»» upload	boolean	false	none	If true, a file may be uploaded/added to this folder
»» archive	boolean	false	none	If true, the file may be archived
»» cut	boolean	false	none	If true, the file may be cut into clipboard
»» copy	boolean	false	none	If true, the file may be copied into clipboard
»» paste	boolean	false	none	If true, the clipboard content can be pasted here
»» newFolder	boolean	false	none	If true, a new folder can be created here
»» rename	boolean	false	none	If true, the file can be renamed
»» delete	boolean	false	none	If true, the file can be deleted
»» permanentDelete	boolean	false	none	If true, the file can be permanently deleted
»» webLink	boolean	false	none	If true, the file can be shared through a weblink
»» showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
»» downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
»» newFile	boolean	false	none	If true, a new file can be created in this folder
»» update	boolean	false	none	If true, a request can be made to upload a new version of this file
» zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
»» percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
»» averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
»» estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…
» lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
» firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
» metadataMap	object	false	none	A map of IDs and metadata types
»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
synchronizationStatus	Unknown
synchronizationStatus	NotSynchronizing
synchronizationStatus	NotAvailable
synchronizationStatus	Archived
synchronizationStatus	PendingDownload
synchronizationStatus	Downloading
synchronizationStatus	Available
synchronizationStatus	PendingUpload
synchronizationStatus	Scanning
synchronizationStatus	Uploading

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get an authorization token

Code samples

# You can also use wget
curl -X POST /api/public/share/{sharekey}/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Real-Ip: string'

POST /api/public/share/{sharekey}/token

Get a share Authorization (token) based on user:password that can be used for shares that require authorization. It can be sent in a header as ‘Authorization: Bearer ’ (Recommended), as a query parameter 'authroization= (Not recommended) or provided in a cookie. It is valid for 900000 minutes, but if a download was started before timeout this will be allowed to continue until finished (even if Range is used in multiple requests).

Body parameter

{
  "grant_type": "password",
  "username": "alice@example.com",
  "password": "SuperSecretPassword123!"
}

Parameters

Name	In	Type	Required	Description
sharekey	path	string	true	The (secret) link provided to the recipient.
setcookie	query	boolean	false	If a correct authorization is provided in the Authorization header (Authorization: Basic <Base64Encoded(user:password)> and setcookie=true then a cookie with the authorization will be set.
X-Real-Ip	header	string	false	none
body	body	TokenRequest	false	none

Example responses

201 Response

{
  "expiresAt": "2025-10-31T13:35:43.773+01:00",
  "token": "share-fef2a859a9a6b76d91cc0aff224a34214c9b449baa91e0ba14902e7ecbe674b1"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	None

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» token	string	false	none	The secret token. This is a secret and shall be treated as such.
» expiresAt	string	false	none	The timestamp when the token will expire, expressed as ISO-8601 extended offset date-time format
» id	UUID(uuid)	false	none	The Identity of the token, can be used to manage the token but not use it
» expiry	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Support

Operations related to user support

Create a Support Request

Code samples

# You can also use wget
curl -X POST /api/support \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json'

POST /api/support

Create and send a Support Request.

Body parameter

file: string
description: string

Parameters

Name	In	Type	Required	Description
body	body	MultiPartSupportBody	false	none

Example responses

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

TokenManagement

Operations to support management of tokens

List tokens

Code samples

# You can also use wget
curl -X GET /api/tokens \
  -H 'Accept: application/json'

GET /api/tokens

Lists all tokens for this user.

Example responses

200 Response

[
  {
    "tokenId": "string",
    "tokenName": "string",
    "clientIdentifier": "string",
    "created": "2011-12-03T10:15:30+01:00",
    "scope": {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    },
    "validUntil": "2011-12-03T10:15:30+01:00",
    "id": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[TokenInformation]	false	none	none
» tokenId	UUID(uuid)	false	none	The Identity of the token, can be used to manage the token but not use it
» tokenName	string	false	none	The human readable name/description of the token
» clientIdentifier	string	false	none	An optional clientIdentifier if a client is a used for this token
» created	string	false	none	The timestamp of when the token was created (ISO-8601 extended offset date-time format).
» scope	SPScope	false	none	The scope of the token
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» validUntil	string	false	none	The timestamp in in (ISO-8601 extended offset date-time format) when the token will expire.
» id	UUID(uuid)	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create token

Code samples

# You can also use wget
curl -X POST /api/tokens \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/tokens

Create a new token for this user.

Body parameter

{
  "tokenName": "string",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "validity": 0,
  "password": [
    "a",
    "b",
    "c",
    "1"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	NewTokenRequest	false	none

Example responses

201 Response

[
  {
    "token": "string",
    "expiresAt": "2023-12-03T10:15:30+01:00",
    "id": "string",
    "expiry": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[TokenAndExpiry]	false	none	none
» token	string	false	none	The secret token. This is a secret and shall be treated as such.
» expiresAt	string	false	none	The timestamp when the token will expire, expressed as ISO-8601 extended offset date-time format
» id	UUID(uuid)	false	none	The Identity of the token, can be used to manage the token but not use it
» expiry	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete token

Code samples

# You can also use wget
curl -X DELETE /api/tokens/{tokenId} \
  -H 'Accept: application/json'

DELETE /api/tokens/{tokenId}

Delete a token.

Parameters

Name	In	Type	Required	Description
tokenId	path	UUID	true	none

Example responses

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	None
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get token

Code samples

# You can also use wget
curl -X GET /api/tokens/{tokenid} \
  -H 'Accept: application/json'

GET /api/tokens/{tokenid}

Retrieve a specific token

Parameters

Name	In	Type	Required	Description
tokenid	path	UUID	true	none

Example responses

200 Response

{
  "tokenId": "string",
  "tokenName": "string",
  "clientIdentifier": "string",
  "created": "2011-12-03T10:15:30+01:00",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "validUntil": "2011-12-03T10:15:30+01:00",
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tokenId	UUID(uuid)	false	none	The Identity of the token, can be used to manage the token but not use it
» tokenName	string	false	none	The human readable name/description of the token
» clientIdentifier	string	false	none	An optional clientIdentifier if a client is a used for this token
» created	string	false	none	The timestamp of when the token was created (ISO-8601 extended offset date-time format).
» scope	SPScope	false	none	The scope of the token
»» name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
»» description	string	false	none	A user friendly description of the scope.
»» clients	[Client]	true	none	The client type(s) where this scope is valid.
»» permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
»»» additionalProperties	Permission	false	none	none
»»»» all	boolean	false	none	none
»»»» create	boolean	false	none	none
»»»» list	boolean	false	none	none
»»»» get	boolean	false	none	none
»»»» access	boolean	false	none	none
»»»» modify	boolean	false	none	none
»»»» delete	boolean	false	none	none
»» limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
»»» additionalProperties	any	false	none	none
»» extensions	object	false	none	For future usage.
»»» additionalProperties	any	false	none	none
» validUntil	string	false	none	The timestamp in in (ISO-8601 extended offset date-time format) when the token will expire.
» id	UUID(uuid)	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Users

All operations related to user management.

Get co-workers

Code samples

# You can also use wget
curl -X GET /api/users \
  -H 'Accept: application/json'

GET /api/users

Gets user info for all users in a zone domain.

Parameters

Name	In	Type	Required	Description
filter	query	string	false	An optional search filter of ‘filter=filtervalue’ where filtervalue consists of one or more URLEncoded ‘key=value’ to be matched for all coworkers. An Empty filter will return all coworkers. Note that the filter needs to be URLEncoded. Here is a list of Key values: name a name that, ignoring case, must be part of the coworker’s display name (real and/or verified name) or identity name. userId Field matched exactly. externalUserName Field matched exactly. emailAddress A match to at least one of the available e-mail addresses for the user. createdBy Field matched exactly, a userId. Example: bob@example.com personalIdentityData.personalIdentityType Field matched exactly. Example: PersonalIdentityData.personalIdentityType=SwedishPersonalNumber (Note: To search for PersonalIdentityData you must set both the personalIdentityType and personalIdentity). personalIdentityData.personalIdentity field matched exactly. Example: PersonalIdentityData.personalIdentity=202401012394 (Note: To search for PersonalIdentityData you must set both the personalIdentityType and personalIdentity). authorization match against any of the provided authorizations from Schema: UserAuthorizationData. Examples: Guest, External, Internal, Manager, Administrator. activityStatus Match against any of the provided. Example: Active, Inactive, Removed. If non are provided a search will be carried out on Active as default. Removed will be included in the result only if the includeRemoved query param is set. tenantId A tenant id that the coworker must have. The special SSP TenantId (tenant id 0000) can be used to limit the search to only SSP users. Examples: of search queries are: externalUserName=1244 send URLEncoded as filter=externalUserName%3D1244 userId=a@example.com send URLEncoded as filter=userId%3Da%40example.com createdBy=a@example.com&authorization=Guest send URLEncoded as filter=createdBy%3Da%40example.com%26authorization%3DGuest activityStatus=Active send URLEncoded as filter=activityStatus%3DActive activityStatus[]=Active&activityStatus[]=Inactive send URLEncoded as filter=activityStatus%5B%5D%3DActive%26activityStatus%5B%5D%3DInactive
includeRemoved	query	boolean	false	(Deprecated, the parameter will be removed. Please use activityStatus=Removed instead). If true, include removed user accounts in result.
page	query	integer	false	Pagination: Provide this page number, starting from 1
pageSize	query	integer	false	Pagination: Page size
sortBy	query	array[string]	false	An optional instruction to sort the result in a specific sort order. If given, the result will be sorted accordingly by applying each sorting order in the order it is given. The available sorting types are constructed using ascending (default if non is provided) or descending represented as ‘+’ (%2B URLEncoded) or ‘-’ together with one of these keys: displayName, userId, active, authorization, tenantId. If no sorting order is provided, ascendingDisplayName will be used as default. Examples: Sort by ascending userId: +userId send URLEncoded as sortBy=%2BuserId. Sort by descending authorization and descending userId-authorization&-userId send URLEncoded as sortBy=-authorization&sortBy=-userId. Note: When providing multiple sorting orders, this can also be done in array-style example: sortBy[]=%2BuserId&sortBy[]=-displayName or by providing the key multiple times, example:sortBy=%2BuserId&sortBy=-displayName

Example responses

200 Response

[
  {
    "actions": {
      "allowedAuthorizations": [
        "Guest",
        "External",
        "Internal"
      ],
      "assignNewCredentials": true,
      "canDeactivate": true,
      "canGetPersonalIdentity": false,
      "canGetSignOnHistory": true,
      "canHide": false,
      "canReactivate": false,
      "canRemove": false,
      "canRemovePersonalIdentity": false,
      "canSetPersonalIdentity": true,
      "canUnhide": true,
      "changeAuthorizationData": true,
      "changeExternalId": false,
      "changePersonalData": false
    },
    "active": true,
    "assignedCredentialsAt": "2024-01-16T16:43:05.218+01:00",
    "assignedCredentialsBy": "jonas@example.com",
    "authorization": "Guest",
    "createableUserAccountTypes": [],
    "createableZoneTypes": [],
    "createdAt": "2024-01-16T16:43:05.218+01:00",
    "createdBy": "jonas@example.com",
    "displayName": "A Guest",
    "externalUserName": "",
    "groups": {},
    "hidden": true,
    "hiddenPassword": false,
    "passwordChangeRequired": false,
    "personalData": {
      "emailAddresses": "jonas@freemail.se",
      "preferredLanguageCode": "en",
      "realName": "A Guest"
    },
    "removed": false,
    "removedAt": "",
    "userId": "a.guest@example.com"
  }
]

"UserId, DisplayName, Active, Removed, ExternalUserName, RealName, Email, Language, Authorization, VerifiedName, hiddenCreatedAt, CreatedBy, a.guest@example.com, A Guest, true, false, , A Guest, jonas@freemail.se, en, Guest, null, true2024-01-16T16:43:05.218+01:00, jonas@example.com, a.visitor@example.com, A Visitor, true, false, , A Visitor, jonas@freemail.se, en, Visitor, null, true2024-01-23T14:55:54.316+01:00, jonas@example.com,"

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UserInformationData]	false	none	none
» userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
» displayName	string	false	none	A (calculated) name to use for display purposes.
» active	boolean	false	none	If the user account is active or not.
» removed	boolean	false	none	If the user account is removed or not.
» externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
» personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
»» realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
»» emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
»» preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
» passwordChangeRequired	boolean	false	none	If true user should be required to change password
» authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
» hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
» password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
» actions	UserActions	false	none	A list of actions that the user can do.
»» changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
»» changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
»» changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
»» allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
»» assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
»» canDeactivate	boolean	false	none	True if the current user can deactivate this user.
»» canReactivate	boolean	false	none	True if the current user can reactivate this user.
»» canRemove	boolean	false	none	True if the current user can permanently remove this user account.
»» canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
»» canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
»» canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
»» canHide	boolean	false	none	True if the current user can make this user account hidden.
»» canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
»» canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.
» verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
» hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
» createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
» createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
»» additionalProperties	string(uuid)	false	none	none
» createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
» createdBy	string	false	none	A userID of the user that created this account
» removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
» removedBy	string	false	none	A userID of the user that removed this account
» assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
» assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
» tenantId	string	false	none	The tenantId if the user belongs to a tenant
» tenantName	string	false	none	The tenantName if the user belongs to a tenant

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create user

Code samples

# You can also use wget
curl -X POST /api/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/users

Creates a new user in the same zone domain as the calling user.

Body parameter

{
  "userId": "bob@goodtools.com",
  "externalUserName": "635",
  "personalData": {
    "realName": "Bob Johnson",
    "emailAddresses": "bob@goodtools.com",
    "preferredLanguageCode": "en"
  },
  "authorization": "None",
  "hiddenPassword": false,
  "hidden": false
}

Parameters

Name	In	Type	Required	Description
body	body	UserInformationInData	false	none

Example responses

201 Response

{
  "actions": {
    "allowedAuthorizations": [
      "Guest",
      "External",
      "Internal",
      "Manager"
    ],
    "assignNewCredentials": true,
    "canDeactivate": true,
    "canGetPersonalIdentity": false,
    "canGetSignOnHistory": true,
    "canHide": false,
    "canReactivate": false,
    "canRemove": false,
    "canRemovePersonalIdentity": false,
    "canSetPersonalIdentity": true,
    "canUnhide": false,
    "changeAuthorizationData": true,
    "changeExternalId": false,
    "changePersonalData": false
  },
  "active": true,
  "authorization": "Internal",
  "createableUserAccountTypes": [],
  "createableZoneTypes": [
    {
      "allowedSynchronizationModes": [
        "Passive",
        "Protected",
        "Inactive",
        "Paused",
        "Active",
        "All"
      ],
      "category": "Personal",
      "defaultSynchronizationMode": "Active",
      "description": "Personal",
      "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
    }
  ],
  "createdAt": 1709799831619,
  "createdBy": "marc@example.com",
  "displayName": "Bob Johnson",
  "externalUserName": "",
  "groups": {},
  "hidden": false,
  "hiddenPassword": false,
  "passwordChangeRequired": true,
  "personalData": {
    "emailAddresses": "bob@example.com",
    "preferredLanguageCode": "en",
    "realName": "Bob Johnson"
  },
  "removed": false,
  "removedAt": -1,
  "userId": "bob@example.com"
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
» displayName	string	false	none	A (calculated) name to use for display purposes.
» active	boolean	false	none	If the user account is active or not.
» removed	boolean	false	none	If the user account is removed or not.
» externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
» personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
»» realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
»» emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
»» preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
» passwordChangeRequired	boolean	false	none	If true user should be required to change password
» authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
» hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
» password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
» actions	UserActions	false	none	A list of actions that the user can do.
»» changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
»» changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
»» changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
»» allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
»» assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
»» canDeactivate	boolean	false	none	True if the current user can deactivate this user.
»» canReactivate	boolean	false	none	True if the current user can reactivate this user.
»» canRemove	boolean	false	none	True if the current user can permanently remove this user account.
»» canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
»» canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
»» canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
»» canHide	boolean	false	none	True if the current user can make this user account hidden.
»» canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
»» canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.
» verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
» hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
» createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
» createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
»» additionalProperties	string(uuid)	false	none	none
» createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
» createdBy	string	false	none	A userID of the user that created this account
» removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
» removedBy	string	false	none	A userID of the user that removed this account
» assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
» assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
» tenantId	string	false	none	The tenantId if the user belongs to a tenant
» tenantName	string	false	none	The tenantName if the user belongs to a tenant

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get user info, extends session lifetime

Code samples

# You can also use wget
curl -X GET /api/users/me \
  -H 'Accept: application/json'

GET /api/users/me

Gets user info about the calling user. If renew or renewonly is > 0, the session lifetime is extended with the value provided.

Parameters

Name	In	Type	Required	Description
renew	query	integer(int64)	false	(Deprecated) If renew > 60000 the session lifetime is extended and the endpoint returns information about the user (uses milliseconds). Note this field is deprecated, please use renewInSeconds.
renewInSeconds	query	integer(int64)	false	If renew > 60 the session lifetime is extended and the endpoint returns information about the user (uses seconds).
renewOnlyInSeconds	query	integer(int64)	false	Use >= 60 (seconds) or 0 (ignored). If renewOnlyInSeconds > 60 the session lifetime is extended and the endpoint returns nothing (uses seconds).
renewonly	query	integer(int64)	false	(Deprecated) If renewonly > 60000 the session lifetime is extended and the endpoint returns nothing (uses milliseconds). Note this field is deprecated, please use renewOnlyInSeconds.

Example responses

200 Response

{
  "actions": {
    "allowedAuthorizations": [
      "Internal"
    ],
    "assignNewCredentials": false,
    "canDeactivate": false,
    "canGetPersonalIdentity": false,
    "canGetSignOnHistory": true,
    "canHide": false,
    "canReactivate": false,
    "canRemove": false,
    "canRemovePersonalIdentity": false,
    "canSetPersonalIdentity": true,
    "canUnhide": false,
    "changeAuthorizationData": false,
    "changeExternalId": true,
    "changePersonalData": true
  },
  "active": true,
  "assignedCredentialsAt": "",
  "authorization": "Internal",
  "createableUserAccountTypes": [],
  "createableZoneTypes": [
    {
      "allowedSynchronizationModes": [
        "Active",
        "Paused",
        "Protected",
        "All",
        "Inactive",
        "Passive"
      ],
      "category": "Personal",
      "defaultSynchronizationMode": "Active",
      "description": "Personal",
      "id": "9963a849-074d-4164-87a1-18be9d3c361a"
    }
  ],
  "createdAt": "",
  "displayName": "John",
  "groups": {},
  "hidden": false,
  "hiddenPassword": false,
  "passwordChangeRequired": false,
  "personalData": {
    "emailAddresses": "john@example.com",
    "preferredLanguageCode": "en",
    "realName": "John Doe"
  },
  "removed": false,
  "removedAt": "",
  "tenantId": "null",
  "userId": "john@example.com",
  "sessionExpiryIn": 5966416
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
204	No Content	OK, No Content	None
401	Unauthorized	Unauthorized	Inline
409	Conflict	Conflict - renew failed	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
» displayName	string	false	none	A (calculated) name to use for display purposes.
» active	boolean	false	none	If the user account is active or not.
» removed	boolean	false	none	If the user account is removed or not.
» externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
» personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
»» realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
»» emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
»» preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
» passwordChangeRequired	boolean	false	none	If true user should be required to change password
» authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
» hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
» password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
» actions	UserActions	false	none	A list of actions that the user can do.
»» changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
»» changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
»» changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
»» allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
»» assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
»» canDeactivate	boolean	false	none	True if the current user can deactivate this user.
»» canReactivate	boolean	false	none	True if the current user can reactivate this user.
»» canRemove	boolean	false	none	True if the current user can permanently remove this user account.
»» canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
»» canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
»» canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
»» canHide	boolean	false	none	True if the current user can make this user account hidden.
»» canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
»» canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.
» verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
» hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
» createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
» createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
»» additionalProperties	string(uuid)	false	none	none
» createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
» createdBy	string	false	none	A userID of the user that created this account
» removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
» removedBy	string	false	none	A userID of the user that removed this account
» assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
» assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
» tenantId	string	false	none	The tenantId if the user belongs to a tenant
» tenantName	string	false	none	The tenantName if the user belongs to a tenant
» sessionExpiryIn	integer(int64)	false	none	The validity of the current session expressed in milliseconds

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 409

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get my favorite zones

Code samples

# You can also use wget
curl -X GET /api/users/me/favorites/zone \
  -H 'Accept: application/json'

GET /api/users/me/favorites/zone

Get a list of my favorite zones.

Example responses

200 Response

[
  {
    "id": "string",
    "name": "economy2023",
    "description": "All files related to Economy year 2023. Ask Belinda for further information.",
    "type": "56e69c5c-0579-41a8-8597-0d2946908a9",
    "createdAt": "2011-12-03T10:15:30+01:00",
    "createdBy": "bob@example.com",
    "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
    "currentSize": 0,
    "typeName": "Normal",
    "webAccessible": true,
    "synkerAccessible": true,
    "ssiAccessible": true,
    "allowExternalSharing": true,
    "useECM": true,
    "ecmData": {
      "parameter": "string",
      "status": "string",
      "error": "string"
    },
    "localSynchronizationStatus": "Unknown",
    "localSize": 0,
    "numberOfUsers": 0,
    "zoneActions": {
      "assignAccessRights": true,
      "leave": true,
      "changeSynchronizingClientEnabled": true,
      "changeSynkzoneWebEnabled": true,
      "changeSynkzoneAPIEnabled": true,
      "changeExternalSharingEnabled": true,
      "changeZoneType": true,
      "assignableZoneTypes": [
        {
          "id": "string",
          "description": "string",
          "category": "Personal",
          "defaultSynchronizationMode": "Inactive",
          "allowedSynchronizationModes": [
            "Inactive"
          ]
        }
      ]
    },
    "zoneTypeData": {
      "id": "string",
      "description": "string",
      "category": "Personal",
      "defaultSynchronizationMode": "Inactive",
      "allowedSynchronizationModes": [
        "Inactive"
      ]
    },
    "currentAccess": {
      "memberId": "bob@example.com",
      "accessLevel": "None",
      "displayName": "string",
      "authorization": "None",
      "memberType": "User"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneData]	false	none	[Information regarding a specific zone.]
» id	UUID(uuid)	false	none	The zoneId. Unique zone identifier
» name	string	false	none	The (human readable) name of the zone
» description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
» type	UUID(uuid)	false	none	Zone type specification, which determines a number of zone properties.
» createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
» createdBy	string	false	none	Name of the user that created the zone.
» rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
» currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
» typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
» webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
» synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
» ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
» allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
» useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
» ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
»» parameter	string	false	none	The ECM parameter for a zone that uses ECM
»» status	string	false	none	Current ECM status for the zone
»» error	string	false	none	ECM function error message
» localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
» localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
» numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
» zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
»» leave	boolean	false	none	The current user can leave the zone
»» changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
»» changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
»» changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
»» changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
»» changeZoneType	boolean	false	none	The current user can change the zone type
»» assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone
»»» id	UUID(uuid)	false	none	The zoneTypeId
»»» description	string	false	none	A human readable description of the zoneType
»»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.
»» memberId	string	true	none	The memberId, a userId or a groupId.
»» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
localSynchronizationStatus	Unknown
localSynchronizationStatus	Preparing
localSynchronizationStatus	Quarantine
localSynchronizationStatus	Paused
localSynchronizationStatus	Restoring
localSynchronizationStatus	Unmapped
localSynchronizationStatus	MappingError
localSynchronizationStatus	WriteProtected
localSynchronizationStatus	InsufficientFileSystem
localSynchronizationStatus	NoDiskSpace
localSynchronizationStatus	ClockError
localSynchronizationStatus	ECMError
localSynchronizationStatus	Offline
localSynchronizationStatus	Synchronizing
localSynchronizationStatus	Synchronized
localSynchronizationStatus	Inactive
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Add favorite zone

Code samples

# You can also use wget
curl -X POST /api/users/me/favorites/zone/{zoneid} \
  -H 'Accept: application/json'

POST /api/users/me/favorites/zone/{zoneid}

Add a favorite zoneId to my list of favorite zoneids.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

408 Response

{
  "error": "TIMEOUT",
  "message": "File upload time out"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created with no content	None
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not acceptable	Inline
408	Request Timeout	Request Timeout	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete favorite zone

Code samples

# You can also use wget
curl -X DELETE /api/users/me/favorites/zone/{zoneid} \
  -H 'Accept: application/json'

DELETE /api/users/me/favorites/zone/{zoneid}

Delete a zoneid in my list of favorite zoneids.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none

Example responses

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

408 Response

{
  "error": "TIMEOUT",
  "message": "File upload time out"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content (UUID was deleted or did not exist)	None
401	Unauthorized	Unauthorized	Inline
408	Request Timeout	Request Timeout	Inline
500	Internal Server Error	Internal Server Error	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 408

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Change Password

Code samples

# You can also use wget
curl -X PUT /api/users/me/password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/users/me/password

Change the signed on users password.

Body parameter

{
  "oldPassword": [
    "a",
    "b",
    "c"
  ],
  "newPassword": [
    "1",
    "2",
    "3"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	NewPasswordRequest	false	none

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden/Not Allowed	Inline
405	Method Not Allowed	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 405

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get Personal Identity Types

Code samples

# You can also use wget
curl -X GET /api/users/personal-identity \
  -H 'Accept: application/json'

GET /api/users/personal-identity

Get Personal Identity Types.

Example responses

200 Response

[
  "SwedishPersonalNumber"
]

Responses

Status	Meaning	Description	Schema
200	OK	Returns the Personal Identity Types	Inline
401	Unauthorized	Unauthorized	Inline
500	Internal Server Error	Failed	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get user information for given user

Code samples

# You can also use wget
curl -X GET /api/users/{userid} \
  -H 'Accept: application/json'

GET /api/users/{userid}

Gets user information for the user with the given user id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

200 Response

{
  "actions": {
    "allowedAuthorizations": [
      "Guest",
      "External",
      "Internal",
      "Manager"
    ],
    "assignNewCredentials": true,
    "canDeactivate": true,
    "canGetPersonalIdentity": false,
    "canGetSignOnHistory": true,
    "canHide": false,
    "canReactivate": false,
    "canRemove": false,
    "canRemovePersonalIdentity": false,
    "canSetPersonalIdentity": true,
    "canUnhide": false,
    "changeAuthorizationData": true,
    "changeExternalId": false,
    "changePersonalData": false
  },
  "active": true,
  "authorization": "Internal",
  "createableUserAccountTypes": [],
  "createableZoneTypes": [
    {
      "allowedSynchronizationModes": [
        "Passive",
        "Protected",
        "Inactive",
        "Paused",
        "Active",
        "All"
      ],
      "category": "Personal",
      "defaultSynchronizationMode": "Active",
      "description": "Personal",
      "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
    }
  ],
  "createdAt": "2023-12-14T15:04:20.022+01:00",
  "createdBy": "marc@example.com",
  "displayName": "Bob Johnson",
  "externalUserName": "",
  "groups": {},
  "hidden": false,
  "hiddenPassword": false,
  "passwordChangeRequired": true,
  "personalData": {
    "emailAddresses": "bob@example.com",
    "preferredLanguageCode": "en",
    "realName": "Bob Johnson"
  },
  "removed": false,
  "removedAt": "",
  "userId": "bob@example.com"
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
» displayName	string	false	none	A (calculated) name to use for display purposes.
» active	boolean	false	none	If the user account is active or not.
» removed	boolean	false	none	If the user account is removed or not.
» externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
» personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
»» realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
»» emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
»» preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
» passwordChangeRequired	boolean	false	none	If true user should be required to change password
» authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
» hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
» password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
» actions	UserActions	false	none	A list of actions that the user can do.
»» changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
»» changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
»» changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
»» allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
»» assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
»» canDeactivate	boolean	false	none	True if the current user can deactivate this user.
»» canReactivate	boolean	false	none	True if the current user can reactivate this user.
»» canRemove	boolean	false	none	True if the current user can permanently remove this user account.
»» canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
»» canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
»» canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
»» canHide	boolean	false	none	True if the current user can make this user account hidden.
»» canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
»» canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.
» verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
» hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
» createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
» createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
»» additionalProperties	string(uuid)	false	none	none
» createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
» createdBy	string	false	none	A userID of the user that created this account
» removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
» removedBy	string	false	none	A userID of the user that removed this account
» assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
» assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
» tenantId	string	false	none	The tenantId if the user belongs to a tenant
» tenantName	string	false	none	The tenantName if the user belongs to a tenant

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update user

Code samples

# You can also use wget
curl -X PUT /api/users/{userid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/users/{userid}

Updates the user with the given user id.

Body parameter

{
  "realName": "string",
  "emailAddresses": "string",
  "preferredLanguageCode": "string",
  "active": true,
  "hidden": false,
  "externalUserName": "string",
  "userAuthorizationData": "None"
}

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.
body	body	UserData	false	none

Example responses

200 Response

{
  "actions": {
    "allowedAuthorizations": [
      "Guest",
      "External",
      "Internal",
      "Manager"
    ],
    "assignNewCredentials": true,
    "canDeactivate": true,
    "canGetPersonalIdentity": false,
    "canGetSignOnHistory": true,
    "canHide": false,
    "canReactivate": false,
    "canRemove": false,
    "canRemovePersonalIdentity": false,
    "canSetPersonalIdentity": true,
    "canUnhide": false,
    "changeAuthorizationData": true,
    "changeExternalId": false,
    "changePersonalData": false
  },
  "active": true,
  "authorization": "Internal",
  "createableUserAccountTypes": [],
  "createableZoneTypes": [
    {
      "allowedSynchronizationModes": [
        "Passive",
        "Protected",
        "Inactive",
        "Paused",
        "Active",
        "All"
      ],
      "category": "Personal",
      "defaultSynchronizationMode": "Active",
      "description": "Personal",
      "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
    }
  ],
  "createdAt": "2023-12-14T15:04:20.022+01:00",
  "createdBy": "marc@example.com",
  "displayName": "Bob Johnson",
  "externalUserName": "",
  "groups": {},
  "hidden": false,
  "hiddenPassword": false,
  "passwordChangeRequired": true,
  "personalData": {
    "emailAddresses": "bob@example.com",
    "preferredLanguageCode": "en",
    "realName": "Bob Johnson"
  },
  "removed": false,
  "removedAt": "",
  "userId": "bob@example.com"
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
» displayName	string	false	none	A (calculated) name to use for display purposes.
» active	boolean	false	none	If the user account is active or not.
» removed	boolean	false	none	If the user account is removed or not.
» externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
» personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
»» realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
»» emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
»» preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
» passwordChangeRequired	boolean	false	none	If true user should be required to change password
» authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
» hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
» password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
» actions	UserActions	false	none	A list of actions that the user can do.
»» changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
»» changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
»» changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
»» allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
»» assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
»» canDeactivate	boolean	false	none	True if the current user can deactivate this user.
»» canReactivate	boolean	false	none	True if the current user can reactivate this user.
»» canRemove	boolean	false	none	True if the current user can permanently remove this user account.
»» canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
»» canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
»» canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
»» canHide	boolean	false	none	True if the current user can make this user account hidden.
»» canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
»» canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.
» verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
» hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
» createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
» createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
»» additionalProperties	string(uuid)	false	none	none
» createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
» createdBy	string	false	none	A userID of the user that created this account
» removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
» removedBy	string	false	none	A userID of the user that removed this account
» assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
» assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
» tenantId	string	false	none	The tenantId if the user belongs to a tenant
» tenantName	string	false	none	The tenantName if the user belongs to a tenant

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete or deactivate user

Code samples

# You can also use wget
curl -X DELETE /api/users/{userid} \
  -H 'Accept: application/json'

DELETE /api/users/{userid}

Deletes or deactivates the user with the given user id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.
softDelete	query	boolean	false	If true deactivate user, if false remove the user.

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get log on history for given user

Code samples

# You can also use wget
curl -X GET /api/users/{userid}/logonhistory \
  -H 'Accept: application/json'

GET /api/users/{userid}/logonhistory

Get log on history for for the user with the given user id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.
page	query	integer	false	Pagination. The number of entries on a page
pageSize	query	integer(int32)	false	none

Example responses

200 Response

[
  {
    "accessTime": "2023-02-27T13:23:01.377+01:00",
    "clientType": "SynkzoneSSI",
    "clientVersion": "2170000",
    "failed": false,
    "ipAddress": "181.141.30.232",
    "onbAddress": "42f8f90eda2b69a5@180.133.30.14:60122"
  },
  {
    "accessTime": "2023-03-06T14:44:44.254+01:00",
    "clientType": "Synker",
    "clientVersion": "2170000",
    "failed": false,
    "ipAddress": "90.221.211.217",
    "onbAddress": "42f8f90eda2b69a5@180.133.30.14:60122"
  }
]

"AccessTime, IP-Address, Failed, ClientType, ClientVersion, ONBAddress 2024-05-28T16:30:21.516+02:00, 180.133.30.14, false, SynkzoneSSI, 2420200, 42f8f90eda2b69a5@180.133.30.14:60122 2024-05-28T16:21:22.464+02:00, 180.133.30.14, false, SynkzoneSSI, 2420200, 42f8f90eda2b69a5@180.133.30.14:58884"

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
500	Internal Server Error	Internal Server Error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ClientInformation1]	false	none	none
» onbAddress	string	false	none	none
» ipAddress	string	false	none	none
» clientType	string	false	none	none
» clientVersion	string	false	none	none
» accessTime	integer(int64)	false	none	none
» failed	boolean	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update OTP for given user

Code samples

# You can also use wget
curl -X PUT /api/users/{userid}/otp \
  -H 'Accept: application/json'

PUT /api/users/{userid}/otp

Updates the OTP for the user with the given user id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Request executed successfully	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update password for given user

Code samples

# You can also use wget
curl -X PUT /api/users/{userid}/password \
  -H 'Accept: application/json'

PUT /api/users/{userid}/password

Updates the password for the user with the given user id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

200 Response

{
  "ok": true,
  "newPassword": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» ok	boolean	false	none	true if a new password was assigned and distributed
» newPassword	[string]	false	none	The new password, only provided if no other means to distribute the password exists

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get Personal Identity Data

Code samples

# You can also use wget
curl -X GET /api/users/{userid}/personal-identity \
  -H 'Accept: application/json'

GET /api/users/{userid}/personal-identity

Get PersonalIdentityData for a user.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

200 Response

{
  "personalIdentity": "200001042381",
  "personalIdentityType": "SwedishPersonalNumber"
}

401 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns the PersonalIdentityData or ‘Unknown’ if the field has been removed or not been set. The personalIdentity can be set by the user or an administrator. Once the user has successfully logged on using the personalIdentity the field cannot be modified, only removed. The UserAction ‘canSetPersonalIdentity’ can be used to see if the field can be set or not.	Inline
401	Unauthorized	Not Allowed	Inline
404	Not Found	Not Found/User is unknown	Inline
500	Internal Server Error	Failed	Inline

Response Schema

Status Code 200

A class to hold the ‘Personal Identity’ of a user, that can be used for identity based sign on.

Name	Type	Required	Restrictions	Description
» personalIdentityType	Type	false	none	The type of personal identity as defined by PersonalIdentityType: Unknown, SwedishPersonalNumber
» personalIdentity	string	false	none	The personal identity according to the specified type

Enumerated Values

Property	Value
personalIdentityType	Unknown
personalIdentityType	SwedishPersonalNumber

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Set PersonalIdentityData

Code samples

# You can also use wget
curl -X POST /api/users/{userid}/personal-identity \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/users/{userid}/personal-identity

Set PersonalIdentityData for a user. The Personal identity can only be set by an administrator, the account holder, or the user that created the account.

Body parameter

{
  "personalIdentityType": "SwedishPersonalNumber",
  "personalIdentity": "200001042381"
}

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.
body	body	PersonalIdentityData	false	none

Example responses

201 Response

{
  "personalIdentityType": "SwedishPersonalNumber",
  "personalIdentity": "200001042381"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created (The identity data was set)	Inline
401	Unauthorized	Not Allowed: This can happen for example:‘Personal identity cannot be set for removed user’, ‘Personal identity cannot be updated’.	Inline
404	Not Found	Not Found/User is unknown	Inline
500	Internal Server Error	Failed	Inline

Response Schema

Status Code 201

A class to hold the ‘Personal Identity’ of a user, that can be used for identity based sign on.

Name	Type	Required	Restrictions	Description
» personalIdentityType	Type	false	none	The type of personal identity as defined by PersonalIdentityType: Unknown, SwedishPersonalNumber
» personalIdentity	string	false	none	The personal identity according to the specified type

Enumerated Values

Property	Value
personalIdentityType	Unknown
personalIdentityType	SwedishPersonalNumber

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Remove Personal Identity Data

Code samples

# You can also use wget
curl -X DELETE /api/users/{userid}/personal-identity \
  -H 'Accept: application/json'

DELETE /api/users/{userid}/personal-identity

Remove PersonalIdentityData for a user. Will lead to a removal of the PersonalIdentityData for privacy reasons.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

200 Response

true

Responses

Status	Meaning	Description	Schema
200	OK	Successfull removal	boolean
401	Unauthorized	Not Allowed	Inline
404	Not Found	Not Found/User is unknown	Inline
500	Internal Server Error	Failed	Inline

Response Schema

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 500

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

ZoneLog

All operations related to the Zone log (including chat messages).

List zone log events

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/zonelog \
  -H 'Accept: text/plain'

GET /api/zones/{zoneid}/zonelog

Lists all the Zone log entries for the given zone that matches the given filtering request.

Note :
The API returns user-provided messages exactly as they were submitted, without any modification or sanitization. These messages may contain raw HTML, JavaScript, or other potentially unsafe content. It is crucial that your application does not render these messages directly as HTML in a browser or any other environment that interprets HTML or JavaScript.

To prevent Cross-Site Scripting (XSS) and other security vulnerabilities:

• Always escape or sanitize user input before rendering it in a web page or any other context where it could be executed.
• Use appropriate encoding mechanisms (e.g., HTML encoding) to ensure that the content is treated as plain text.

Failure to properly handle these messages can result in severe security risks.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
cutoff	query	string	false	Do not extend search beyond this timestamp expressed in ISO8601 (or Unix timestamp in Milliseconds).
earlierThan	query	boolean	false	If true, return entries earlier than timestamp
filter	query	string	false	A String that needs to be part of the entry
ignoreCase	query	boolean	false	If true ignore case of filter
includeFileChanges	query	boolean	false	If true include file changes
includeUserMessages	query	boolean	false	If true include user messages
includeZoneChanges	query	boolean	false	If true include zone changes
limit	query	integer	false	Sets max number of entries to be returned (pagination)
offset	query	integer	false	What offset to use when pagination occurs
summarize	query	boolean	false	If true only provide summary
timestamp	query	string	false	A reference for the search expressed in ISO8601 (or Unix timestamp in Milliseconds), if not provided current global time is used.

Example responses

200 Response

"4cc4182b-eed2-438d-8372-742aa25463d8, 2024-04-04T15:49:29.081+02:00, , EarlierThan, Sökresultat 2024-04-04 15:49 - 2024-05-27 17:43, null, null, null, false, null, null, 1970-01-01T00:59:59.999+01:00 4cc4182b-eed2-438d-8372-742aa25463d8, 2024-04-04T15:49:29.081+02:00, mathal@development.test, Added, Lade till /20240404/Multipart-docx.docx, 79F95C0A5F01767E66D872B6363752B20C26D8BA0000018E17C317E820B42DC6, /20240404/Multipart-docx.docx, null, false, null, null, 2024-04-04T15:49:26.86+02:00 4cc4182b-eed2-438d-8372-742aa25463d8, 2024-05-03T15:47:21.714+02:00, matilda.hallden@development.test, Added, Lade till /checksum(1).md5, 79F95C0A5F01767E66D872B6363752B237632B2A0000018F17CBFE9C8C26E8C9, /checksum(1).md5, null, false, null, null, 2024-05-03T15:47:10.996+02:00"

[
  {
    "creator": "",
    "message": "Sökresultat 2024-04-04 15:49 - 2024-05-27 17:40",
    "objectTime": "1970-01-01T00:59:59.999+01:00",
    "subEntry": false,
    "timestamp": "2024-04-04T15:49:29.081+02:00",
    "type": "EarlierThan"
  },
  {
    "creator": "mathal@development.test",
    "fileId": "79F95C0A5F01767E66D872B6363752B20C26D8BA0000018E17C317E820B42DC6",
    "filePath": "/20240404/Multipart-docx.docx",
    "message": "Lade till /20240404/Multipart-docx.docx",
    "objectTime": "2024-04-04T15:49:26.86+02:00",
    "subEntry": false,
    "timestamp": "2024-04-04T15:49:29.081+02:00",
    "type": "Added"
  },
  {
    "creator": "matilda.hallden@development.test",
    "fileId": "79F95C0A5F01767E66D872B6363752B237632B2A0000018F17CBFE9C8C26E8C9",
    "filePath": "/checksum(1).md5",
    "message": "Lade till /checksum(1).md5",
    "objectTime": "2024-05-03T15:47:10.996+02:00",
    "subEntry": false,
    "timestamp": "2024-05-03T15:47:21.714+02:00",
    "type": "Added"
  }
]

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneLogEntry]	false	none	none
» zoneId	string	false	none	The zoneId
» timestamp	string	false	none	Get the time in ISO8601 when the log entry was made. The timestamp is always unique for the ZoneLogEntry and can be used as id.
» creator	string	false	none	Get the id of the user that made or caused this entry.
» type	string	false	none	Get the main type of entry.
» subEntry	boolean	false	none	Check if this entry is not a main entry, but rather is related to a previous or following event in a way that may make it less relevant to view.
» message	string	false	none	The message of the entry
» fileId	string	false	none	A ZoneFileId if such exists
» filePath	string	false	none	Get any file path associated with this entry.
» userId	string	false	none	Get the id of any user/group associated with this entry (other than the creator), e.g. a user being given a new access level.
» accessLevel	string	false	none	Get any access level associated with this log entry.
» objectName	string	false	none	Get any name or description associated with the object that this entry is about, e.g. a zone or user name, or a sharing URL.
» objectTime	string	false	none	Get any extra time specification associate with the object that this entry is about, e.g. a creation or last modified time for a file version. Expressed as ISO8601.
» zoneTypeName	string	false	none	ZoneTypeName is, where applicable, the name of the type of zone for a newly created zone or that an existing zone has been changed to.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	string	false	none	The error type, expressed as an Enum

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

continued

Name	Type	Required	Restrictions	Description
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	string	false	none	The error type, expressed as an Enum

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

continued

Name	Type	Required	Restrictions	Description
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	string	false	none	The error type, expressed as an Enum

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

continued

Name	Type	Required	Restrictions	Description
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	string	false	none	The error type, expressed as an Enum

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

and

Name	Type	Required	Restrictions	Description
»» anonymous	APIError	false	none	Error codes that describes different failures

continued

Name	Type	Required	Restrictions	Description
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION

Update zone log

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/zonelog?timestamp=string \
  -H 'Content-Type: text/plain' \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/zonelog

Updates the zone log entry for the given zone id and timestamp with the given message.

Note :
The API returns user-provided messages exactly as they were submitted, without any modification or sanitization. These messages may contain raw HTML, JavaScript, or other potentially unsafe content. It is crucial that your application does not render these messages directly as HTML in a browser or any other environment that interprets HTML or JavaScript.

To prevent Cross-Site Scripting (XSS) and other security vulnerabilities:

• Always escape or sanitize user input before rendering it in a web page or any other context where it could be executed.
• Use appropriate encoding mechanisms (e.g., HTML encoding) to ensure that the content is treated as plain text.

Failure to properly handle these messages can result in severe security risks.

Body parameter

string

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
timestamp	query	string	true	The timestamp of the entry to be updated (expressed in ISO8601 or as a Unix timestamp in Milliseconds)
body	body	string	false	none

Example responses

200 Response

{
  "creator": "chris@goodtools.com",
  "message": "\"Please review my latest documents\"",
  "objectTime": "1970-01-01T00:59:59.999+01:00",
  "subEntry": false,
  "timestamp": "2023-03-03T15:39:02.791+01:00",
  "type": "Message"
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» zoneId	string	false	none	The zoneId
» timestamp	string	false	none	Get the time in ISO8601 when the log entry was made. The timestamp is always unique for the ZoneLogEntry and can be used as id.
» creator	string	false	none	Get the id of the user that made or caused this entry.
» type	string	false	none	Get the main type of entry.
» subEntry	boolean	false	none	Check if this entry is not a main entry, but rather is related to a previous or following event in a way that may make it less relevant to view.
» message	string	false	none	The message of the entry
» fileId	string	false	none	A ZoneFileId if such exists
» filePath	string	false	none	Get any file path associated with this entry.
» userId	string	false	none	Get the id of any user/group associated with this entry (other than the creator), e.g. a user being given a new access level.
» accessLevel	string	false	none	Get any access level associated with this log entry.
» objectName	string	false	none	Get any name or description associated with the object that this entry is about, e.g. a zone or user name, or a sharing URL.
» objectTime	string	false	none	Get any extra time specification associate with the object that this entry is about, e.g. a creation or last modified time for a file version. Expressed as ISO8601.
» zoneTypeName	string	false	none	ZoneTypeName is, where applicable, the name of the type of zone for a newly created zone or that an existing zone has been changed to.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create zone log

Code samples

# You can also use wget
curl -X POST /api/zones/{zoneid}/zonelog \
  -H 'Content-Type: text/plain' \
  -H 'Accept: application/json'

POST /api/zones/{zoneid}/zonelog

Creates a new zone log entry in the given zone with the given message.

Note :
The API returns user-provided messages exactly as they were submitted, without any modification or sanitization. These messages may contain raw HTML, JavaScript, or other potentially unsafe content. It is crucial that your application does not render these messages directly as HTML in a browser or any other environment that interprets HTML or JavaScript.

To prevent Cross-Site Scripting (XSS) and other security vulnerabilities:

• Always escape or sanitize user input before rendering it in a web page or any other context where it could be executed.
• Use appropriate encoding mechanisms (e.g., HTML encoding) to ensure that the content is treated as plain text.

Failure to properly handle these messages can result in severe security risks.

Body parameter

string

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
body	body	string	false	none

Example responses

201 Response

{
  "creator": "chris@goodtools.com",
  "message": "\"Please review my latest documents\"",
  "objectTime": "1970-01-01T00:59:59.999+01:00",
  "subEntry": false,
  "timestamp": "2023-03-03T15:39:02.791+01:00",
  "type": "Message"
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» zoneId	string	false	none	The zoneId
» timestamp	string	false	none	Get the time in ISO8601 when the log entry was made. The timestamp is always unique for the ZoneLogEntry and can be used as id.
» creator	string	false	none	Get the id of the user that made or caused this entry.
» type	string	false	none	Get the main type of entry.
» subEntry	boolean	false	none	Check if this entry is not a main entry, but rather is related to a previous or following event in a way that may make it less relevant to view.
» message	string	false	none	The message of the entry
» fileId	string	false	none	A ZoneFileId if such exists
» filePath	string	false	none	Get any file path associated with this entry.
» userId	string	false	none	Get the id of any user/group associated with this entry (other than the creator), e.g. a user being given a new access level.
» accessLevel	string	false	none	Get any access level associated with this log entry.
» objectName	string	false	none	Get any name or description associated with the object that this entry is about, e.g. a zone or user name, or a sharing URL.
» objectTime	string	false	none	Get any extra time specification associate with the object that this entry is about, e.g. a creation or last modified time for a file version. Expressed as ISO8601.
» zoneTypeName	string	false	none	ZoneTypeName is, where applicable, the name of the type of zone for a newly created zone or that an existing zone has been changed to.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Delete zone log entry

Code samples

# You can also use wget
curl -X DELETE /api/zones/{zoneid}/zonelog?timestamp=-1 \
  -H 'Accept: application/json'

DELETE /api/zones/{zoneid}/zonelog

Deletes the zone log entry in the given zone and with the given timestamp. Only applicable to entries of type Message.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
timestamp	query	string	true	The timestamp expressed as ISO8601 (or a String representation of UNIX timestamp in milliseconds), for the entry to be removed.

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Undo file changes for user

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/zonelog/undo?first=string&last=string&userId=string \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/zonelog/undo

If possible, undo the file changes specified in one or more zone log for a specific user. entries, starting with the specified firstEntry up until the specified lastEntry. Only entries that record file changes by the same user as specified in the firstLogEntry are considered, and the rest are ignored.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none
first	query	string	true	Timestamp (ISO8601 or a String representation of UNIX timestamp in milliseconds) of first ZoneLogEntry.
last	query	string	true	Timestamp (ISO8601 or a String representation of UNIX timestamp in milliseconds) of last ZoneLogEntry.
userId	query	string	true	The user ID for the creator of the events to be undone.

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

List log entries for a specific zoneFile.

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/zonelog/{fileid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/zonelog/{fileid}

Lists all the Zone log entries for the given zoneFile.

Parameters

Name	In	Type	Required	Description
fileid	path	string	true	The identity of the file.
zoneid	path	UUID	true	none
limit	query	integer	false	Sets max number of entries to be returned (pagination)
offset	query	integer	false	What offset to use when pagination occurs

Example responses

200 Response

[
  {
    "creator": "matilda@greatexamples.org",
    "fileId": "36AAC4DEF75B45A88B521265A34A45BDC6DFA61200000188175F9E3BE4196DE1",
    "filePath": "/1055346353.gif",
    "message": "Added /1055346353.gif",
    "objectTime": "2023-05-16T14:08:46.85+02:00",
    "subEntry": false,
    "timestamp": "2023-05-16T14:10:22.42+02:00",
    "type": "Added"
  },
  {
    "creator": "matilda@greatexamples.org",
    "fileId": "36AAC4DEF75B45A88B521265A34A45BDC6DFA61200000188175F9E3BE4196DE1",
    "filePath": "/1055346353.gif",
    "message": "Modified /1055346353.gif",
    "objectTime": "2023-05-16T14:10:22.419+02:00",
    "subEntry": false,
    "timestamp": "2023-05-16T14:11:24.945+02:00",
    "type": "Modified"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» zoneId	string	false	none	The zoneId
» timestamp	string	false	none	Get the time in ISO8601 when the log entry was made. The timestamp is always unique for the ZoneLogEntry and can be used as id.
» creator	string	false	none	Get the id of the user that made or caused this entry.
» type	string	false	none	Get the main type of entry.
» subEntry	boolean	false	none	Check if this entry is not a main entry, but rather is related to a previous or following event in a way that may make it less relevant to view.
» message	string	false	none	The message of the entry
» fileId	string	false	none	A ZoneFileId if such exists
» filePath	string	false	none	Get any file path associated with this entry.
» userId	string	false	none	Get the id of any user/group associated with this entry (other than the creator), e.g. a user being given a new access level.
» accessLevel	string	false	none	Get any access level associated with this log entry.
» objectName	string	false	none	Get any name or description associated with the object that this entry is about, e.g. a zone or user name, or a sharing URL.
» objectTime	string	false	none	Get any extra time specification associate with the object that this entry is about, e.g. a creation or last modified time for a file version. Expressed as ISO8601.
» zoneTypeName	string	false	none	ZoneTypeName is, where applicable, the name of the type of zone for a newly created zone or that an existing zone has been changed to.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Zones

All zone operations.

List zones

Code samples

# You can also use wget
curl -X GET /api/zones \
  -H 'Accept: application/json'

GET /api/zones

Lists all zones where the logged in user has access.

Parameters

Name	In	Type	Required	Description
page	query	integer(int32)	false	Pagination: page number starting at 1.
pageSize	query	integer(int32)	false	Pagination: number of entries per page.
zoneId	query	string	false	Optional: ZoneIDs (UUID) expressed either as comma separated list a,b, or in the form zoneId=a&zoneId=b. Note: If parameter is omitted a paginated list of all accessible zones for this user will be returned. Note: Pagination is ignored when using the zoneId parameter.

Example responses

200 Response

[
  {
    "allowExternalSharing": true,
    "createdAt": "2023-02-28T14:15:35.689+01:00",
    "createdBy": "bob@example.com",
    "currentSize": 19564289,
    "description": "230228",
    "id": "4cc4182b-eed2-438d-8372-742aa25463d8",
    "localSize": 0,
    "localSynchronizationStatus": "Preparing",
    "name": "230228",
    "numberOfUsers": 7,
    "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
    "ssiAccessible": true,
    "synkerAccessible": true,
    "type": "56e69c5c-0579-41a8-8597-0d2946908a98",
    "typeName": "Lässkyddad",
    "useECM": false,
    "webAccessible": true,
    "zoneActions": {
      "assignAccessRights": false,
      "assignableZoneTypes": [
        {
          "allowedSynchronizationModes": [
            "Passive",
            "Active",
            "All",
            "Inactive",
            "Paused",
            "Protected"
          ],
          "category": "Group",
          "defaultSynchronizationMode": "Active",
          "description": "Group",
          "id": "5f215c80-1fed-422c-b382-4b162cebe4a8"
        },
        {
          "allowedSynchronizationModes": [
            "Passive",
            "Active",
            "All",
            "Inactive",
            "Paused",
            "Protected"
          ],
          "category": "Normal",
          "defaultSynchronizationMode": "Active",
          "description": "Normal",
          "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
        },
        {
          "allowedSynchronizationModes": [
            "Paused",
            "Protected",
            "Inactive"
          ],
          "category": "ReadProtected",
          "defaultSynchronizationMode": "Protected",
          "description": "Read protected",
          "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
        }
      ],
      "changeExternalSharingEnabled": false,
      "changeSynchronizingClientEnabled": false,
      "changeSynkzoneAPIEnabled": false,
      "changeSynkzoneWebEnabled": false,
      "changeZoneType": false,
      "leave": true
    },
    "zoneTypeData": {
      "allowedSynchronizationModes": [
        "Paused",
        "Protected",
        "Inactive"
      ],
      "category": "ReadProtected",
      "defaultSynchronizationMode": "Protected",
      "description": "Read protected",
      "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
    }
  }
]

400 Response

{
  "error": "ILLEGAL_ARGUMENT",
  "message": "zoneIds must be a 'comma-separated' list of UUIDs or in the form of 'zoneId=a&zoneId=b'"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneData]	false	none	[Information regarding a specific zone.]
» id	UUID(uuid)	false	none	The zoneId. Unique zone identifier
» name	string	false	none	The (human readable) name of the zone
» description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
» type	UUID(uuid)	false	none	Zone type specification, which determines a number of zone properties.
» createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
» createdBy	string	false	none	Name of the user that created the zone.
» rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
» currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
» typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
» webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
» synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
» ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
» allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
» useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
» ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
»» parameter	string	false	none	The ECM parameter for a zone that uses ECM
»» status	string	false	none	Current ECM status for the zone
»» error	string	false	none	ECM function error message
» localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
» localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
» numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
» zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
»» leave	boolean	false	none	The current user can leave the zone
»» changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
»» changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
»» changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
»» changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
»» changeZoneType	boolean	false	none	The current user can change the zone type
»» assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone
»»» id	UUID(uuid)	false	none	The zoneTypeId
»»» description	string	false	none	A human readable description of the zoneType
»»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.
»» memberId	string	true	none	The memberId, a userId or a groupId.
»» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
localSynchronizationStatus	Unknown
localSynchronizationStatus	Preparing
localSynchronizationStatus	Quarantine
localSynchronizationStatus	Paused
localSynchronizationStatus	Restoring
localSynchronizationStatus	Unmapped
localSynchronizationStatus	MappingError
localSynchronizationStatus	WriteProtected
localSynchronizationStatus	InsufficientFileSystem
localSynchronizationStatus	NoDiskSpace
localSynchronizationStatus	ClockError
localSynchronizationStatus	ECMError
localSynchronizationStatus	Offline
localSynchronizationStatus	Synchronizing
localSynchronizationStatus	Synchronized
localSynchronizationStatus	Inactive
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Create zone

Code samples

# You can also use wget
curl -X POST /api/zones \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/zones

Creates a zone using the given values.

Body parameter

{
  "name": "Economy",
  "description": "Internal documents",
  "type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "webAccessible": false,
  "ssiAccessible": false,
  "synkerAccessible": true,
  "allowExternalSharing": false,
  "ecmData": {
    "parameter": "string",
    "status": "string",
    "error": "string"
  },
  "members": [
    {
      "memberId": "bob@example.com",
      "accessLevel": "None",
      "displayName": "string",
      "authorization": "None",
      "memberType": "User"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ChangeableZoneData	false	none

Example responses

201 Response

{
  "allowExternalSharing": true,
  "createdAt": "2023-02-28T14:15:35.689+01:00",
  "createdBy": "bob@example.com",
  "currentAccess": {
    "accessLevel": "Manage",
    "authorization": "Administrator",
    "displayName": "Bob",
    "userId": "bob@example.com"
  },
  "currentSize": 19564289,
  "description": "230228",
  "id": "4cc4182b-eed2-438d-8372-742aa25463d8",
  "localSize": 0,
  "localSynchronizationStatus": "Preparing",
  "name": "230228",
  "numberOfUsers": 7,
  "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
  "ssiAccessible": true,
  "synkerAccessible": true,
  "type": "56e69c5c-0579-41a8-8597-0d2946908a98",
  "typeName": "Lässkyddad",
  "useECM": false,
  "webAccessible": true,
  "zoneActions": {
    "assignAccessRights": false,
    "assignableZoneTypes": [
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Group",
        "defaultSynchronizationMode": "Active",
        "description": "Group",
        "id": "5f215c80-1fed-422c-b382-4b162cebe4a8"
      },
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Normal",
        "defaultSynchronizationMode": "Active",
        "description": "Normal",
        "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
      },
      {
        "allowedSynchronizationModes": [
          "Paused",
          "Protected",
          "Inactive"
        ],
        "category": "ReadProtected",
        "defaultSynchronizationMode": "Protected",
        "description": "Read protected",
        "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
      }
    ],
    "changeExternalSharingEnabled": false,
    "changeSynchronizingClientEnabled": false,
    "changeSynkzoneAPIEnabled": false,
    "changeSynkzoneWebEnabled": false,
    "changeZoneType": false,
    "leave": true
  },
  "zoneTypeData": {
    "allowedSynchronizationModes": [
      "Paused",
      "Protected",
      "Inactive"
    ],
    "category": "ReadProtected",
    "defaultSynchronizationMode": "Protected",
    "description": "Read protected",
    "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
  }
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
201	Created	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 201

Information regarding a specific zone.

Name	Type	Required	Restrictions	Description
» id	UUID(uuid)	false	none	The zoneId. Unique zone identifier
» name	string	false	none	The (human readable) name of the zone
» description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
» type	UUID(uuid)	false	none	Zone type specification, which determines a number of zone properties.
» createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
» createdBy	string	false	none	Name of the user that created the zone.
» rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
» currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
» typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
» webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
» synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
» ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
» allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
» useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
» ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
»» parameter	string	false	none	The ECM parameter for a zone that uses ECM
»» status	string	false	none	Current ECM status for the zone
»» error	string	false	none	ECM function error message
» localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
» localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
» numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
» zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
»» leave	boolean	false	none	The current user can leave the zone
»» changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
»» changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
»» changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
»» changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
»» changeZoneType	boolean	false	none	The current user can change the zone type
»» assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone
»»» id	UUID(uuid)	false	none	The zoneTypeId
»»» description	string	false	none	A human readable description of the zoneType
»»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.
»» memberId	string	true	none	The memberId, a userId or a groupId.
»» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
localSynchronizationStatus	Unknown
localSynchronizationStatus	Preparing
localSynchronizationStatus	Quarantine
localSynchronizationStatus	Paused
localSynchronizationStatus	Restoring
localSynchronizationStatus	Unmapped
localSynchronizationStatus	MappingError
localSynchronizationStatus	WriteProtected
localSynchronizationStatus	InsufficientFileSystem
localSynchronizationStatus	NoDiskSpace
localSynchronizationStatus	ClockError
localSynchronizationStatus	ECMError
localSynchronizationStatus	Offline
localSynchronizationStatus	Synchronizing
localSynchronizationStatus	Synchronized
localSynchronizationStatus	Inactive
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get zone types

Code samples

# You can also use wget
curl -X GET /api/zones/types \
  -H 'Accept: application/json'

GET /api/zones/types

Gets all available zone types.

Example responses

200 Response

[
  {
    "allowedSynchronizationModes": [
      "Passive",
      "Active",
      "All",
      "Inactive",
      "Paused",
      "Protected"
    ],
    "category": "Personal",
    "defaultSynchronizationMode": "Active",
    "description": "Personal",
    "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
  },
  {
    "allowedSynchronizationModes": [
      "Passive",
      "Active",
      "All",
      "Inactive",
      "Paused",
      "Protected"
    ],
    "category": "Normal",
    "defaultSynchronizationMode": "Active",
    "description": "Normal",
    "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
  },
  {
    "allowedSynchronizationModes": [
      "Paused",
      "Protected",
      "Inactive"
    ],
    "category": "ReadProtected",
    "defaultSynchronizationMode": "Protected",
    "description": "Read protected",
    "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
  }
]

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneType]	false	none	none
» id	UUID(uuid)	false	none	The zoneTypeId
» description	string	false	none	A human readable description of the zoneType
» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.

Enumerated Values

Property	Value
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get zone type

Code samples

# You can also use wget
curl -X GET /api/zones/types/{zonetypeid} \
  -H 'Accept: application/json'

GET /api/zones/types/{zonetypeid}

Gets the zone type with the given zone type id.

Parameters

Name	In	Type	Required	Description
zonetypeid	path	UUID	true	The identity of the zonetype to use.

Example responses

200 Response

{
  "description": "Personal",
  "id": "8ce19e4e-cecb-4c53-bd62-9113a2d0af8b"
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	UUID(uuid)	false	none	The zoneTypeId
» description	string	false	none	A human readable description of the zoneType
» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.

Enumerated Values

Property	Value
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get all access levels for a user

Code samples

# You can also use wget
curl -X GET /api/zones/zoneaccess/{userid} \
  -H 'Accept: application/json'

GET /api/zones/zoneaccess/{userid}

List the access levels for a specific user in all zones that I have membership in.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	The identity of the user.

Example responses

200 Response

[
  {
    "myAccessLevelData": "Manage",
    "userAccessLevelData": "Manage",
    "zoneDescription": "TestData from X101 sensor",
    "zoneId": "3c01135a-a7e7-4e3b-92c3-6d6d2ad05939",
    "zoneName": "X101"
  },
  {
    "myAccessLevelData": "Manage",
    "userAccessLevelData": "Manage",
    "zoneDescription": "Internal docs",
    "zoneId": "62a1b26a-3f03-4ce9-b028-d85a361a872b",
    "zoneName": "Economy"
  }
]

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneAccessMembership]	false	none	none
» zoneId	UUID(uuid)	true	none	The zone ID.
» zoneName	string	true	none	The name of the zone.
» zoneDescription	string	false	none	A Human Readable description of the zone.
» myAccessLevelData	AccessLevelData	false	none	My access level in the zone.
» userAccessLevelData	AccessLevelData	false	none	The access level for the user in the zone.

Enumerated Values

Property	Value
myAccessLevelData	None
myAccessLevelData	Access
myAccessLevelData	Add
myAccessLevelData	Update
myAccessLevelData	Modify
myAccessLevelData	Manage
userAccessLevelData	None
userAccessLevelData	Access
userAccessLevelData	Add
userAccessLevelData	Update
userAccessLevelData	Modify
userAccessLevelData	Manage

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get zone data

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}

Gets the data of the zone with the given zone id.

Parameters

Name	In	Type	Required	Description
zoneid	path	string(uuid)	true	Zone ID (UUID)

Example responses

200 Response

{
  "allowExternalSharing": true,
  "createdAt": "2023-02-28T14:15:35.689+01:00",
  "createdBy": "bob@example.com",
  "currentSize": 19564289,
  "description": "230228",
  "id": "4cc4182b-eed2-438d-8372-742aa25463d8",
  "localSize": 0,
  "localSynchronizationStatus": "Preparing",
  "name": "230228",
  "numberOfUsers": 7,
  "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
  "ssiAccessible": true,
  "synkerAccessible": true,
  "type": "56e69c5c-0579-41a8-8597-0d2946908a98",
  "typeName": "Lässkyddad",
  "useECM": false,
  "webAccessible": true,
  "zoneActions": {
    "assignAccessRights": false,
    "assignableZoneTypes": [
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Group",
        "defaultSynchronizationMode": "Active",
        "description": "Group",
        "id": "5f215c80-1fed-422c-b382-4b162cebe4a8"
      },
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Normal",
        "defaultSynchronizationMode": "Active",
        "description": "Normal",
        "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
      },
      {
        "allowedSynchronizationModes": [
          "Paused",
          "Protected",
          "Inactive"
        ],
        "category": "ReadProtected",
        "defaultSynchronizationMode": "Protected",
        "description": "Read protected",
        "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
      }
    ],
    "changeExternalSharingEnabled": false,
    "changeSynchronizingClientEnabled": false,
    "changeSynkzoneAPIEnabled": false,
    "changeSynkzoneWebEnabled": false,
    "changeZoneType": false,
    "leave": true
  },
  "zoneTypeData": {
    "allowedSynchronizationModes": [
      "Paused",
      "Protected",
      "Inactive"
    ],
    "category": "ReadProtected",
    "defaultSynchronizationMode": "Protected",
    "description": "Read protected",
    "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
  }
}

401 Response

{
  "error": "FAILED",
  "message": "INVALID_SESSIONID"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Information regarding a specific zone.

Name	Type	Required	Restrictions	Description
» id	UUID(uuid)	false	none	The zoneId. Unique zone identifier
» name	string	false	none	The (human readable) name of the zone
» description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
» type	UUID(uuid)	false	none	Zone type specification, which determines a number of zone properties.
» createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
» createdBy	string	false	none	Name of the user that created the zone.
» rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
» currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
» typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
» webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
» synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
» ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
» allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
» useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
» ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
»» parameter	string	false	none	The ECM parameter for a zone that uses ECM
»» status	string	false	none	Current ECM status for the zone
»» error	string	false	none	ECM function error message
» localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
» localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
» numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
» zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
»» leave	boolean	false	none	The current user can leave the zone
»» changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
»» changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
»» changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
»» changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
»» changeZoneType	boolean	false	none	The current user can change the zone type
»» assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone
»»» id	UUID(uuid)	false	none	The zoneTypeId
»»» description	string	false	none	A human readable description of the zoneType
»»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.
»» memberId	string	true	none	The memberId, a userId or a groupId.
»» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
localSynchronizationStatus	Unknown
localSynchronizationStatus	Preparing
localSynchronizationStatus	Quarantine
localSynchronizationStatus	Paused
localSynchronizationStatus	Restoring
localSynchronizationStatus	Unmapped
localSynchronizationStatus	MappingError
localSynchronizationStatus	WriteProtected
localSynchronizationStatus	InsufficientFileSystem
localSynchronizationStatus	NoDiskSpace
localSynchronizationStatus	ClockError
localSynchronizationStatus	ECMError
localSynchronizationStatus	Offline
localSynchronizationStatus	Synchronizing
localSynchronizationStatus	Synchronized
localSynchronizationStatus	Inactive
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Update zone

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}

Updates a zone with the given zone id using the given ChangeableZoneData. This method allows modifying zone properties as well as the list of zone members. Note: There is also a separate method where you can change the accesslevel for a single member.

Body parameter

{
  "name": "Economy",
  "description": "Internal documents",
  "type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "webAccessible": false,
  "ssiAccessible": false,
  "synkerAccessible": true,
  "allowExternalSharing": false,
  "ecmData": {
    "parameter": "string",
    "status": "string",
    "error": "string"
  },
  "members": [
    {
      "memberId": "bob@example.com",
      "accessLevel": "None",
      "displayName": "string",
      "authorization": "None",
      "memberType": "User"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	The identity of the zone to use.
relative	query	boolean	false	Indicates whether the list of access rights (members) represents CHANGES to the current access rights or if the specified access rights shall REPLACE the current access rights.
body	body	ChangeableZoneData	false	none

Detailed descriptions

relative: Indicates whether the list of access rights (members) represents CHANGES to the current access rights or if the specified access rights shall REPLACE the current access rights. true: The provided list of access rights represents changes to the current access rights.

false: The specified access rights shall replace the current access rights entirely.

Example responses

200 Response

{
  "allowExternalSharing": true,
  "createdAt": "2023-02-28T14:15:35.689+01:00",
  "createdBy": "bob@example.com",
  "currentAccess": {
    "accessLevel": "Manage",
    "authorization": "Administrator",
    "displayName": "Bob",
    "userId": "bob@example.com"
  },
  "currentSize": 19564289,
  "description": "230228",
  "id": "4cc4182b-eed2-438d-8372-742aa25463d8",
  "localSize": 0,
  "localSynchronizationStatus": "Preparing",
  "name": "230228",
  "numberOfUsers": 7,
  "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
  "ssiAccessible": true,
  "synkerAccessible": true,
  "type": "56e69c5c-0579-41a8-8597-0d2946908a98",
  "typeName": "Lässkyddad",
  "useECM": false,
  "webAccessible": true,
  "zoneActions": {
    "assignAccessRights": false,
    "assignableZoneTypes": [
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Group",
        "defaultSynchronizationMode": "Active",
        "description": "Group",
        "id": "5f215c80-1fed-422c-b382-4b162cebe4a8"
      },
      {
        "allowedSynchronizationModes": [
          "Passive",
          "Active",
          "All",
          "Inactive",
          "Paused",
          "Protected"
        ],
        "category": "Normal",
        "defaultSynchronizationMode": "Active",
        "description": "Normal",
        "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
      },
      {
        "allowedSynchronizationModes": [
          "Paused",
          "Protected",
          "Inactive"
        ],
        "category": "ReadProtected",
        "defaultSynchronizationMode": "Protected",
        "description": "Read protected",
        "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
      }
    ],
    "changeExternalSharingEnabled": false,
    "changeSynchronizingClientEnabled": false,
    "changeSynkzoneAPIEnabled": false,
    "changeSynkzoneWebEnabled": false,
    "changeZoneType": false,
    "leave": true
  },
  "zoneTypeData": {
    "allowedSynchronizationModes": [
      "Paused",
      "Protected",
      "Inactive"
    ],
    "category": "ReadProtected",
    "defaultSynchronizationMode": "Protected",
    "description": "Read protected",
    "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
  }
}

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Information regarding a specific zone.

Name	Type	Required	Restrictions	Description
» id	UUID(uuid)	false	none	The zoneId. Unique zone identifier
» name	string	false	none	The (human readable) name of the zone
» description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
» type	UUID(uuid)	false	none	Zone type specification, which determines a number of zone properties.
» createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
» createdBy	string	false	none	Name of the user that created the zone.
» rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
» currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
» typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
» webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
» synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
» ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
» allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
» useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
» ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
»» parameter	string	false	none	The ECM parameter for a zone that uses ECM
»» status	string	false	none	Current ECM status for the zone
»» error	string	false	none	ECM function error message
» localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
» localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
» numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
» zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
»» assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
»» leave	boolean	false	none	The current user can leave the zone
»» changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
»» changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
»» changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
»» changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
»» changeZoneType	boolean	false	none	The current user can change the zone type
»» assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone
»»» id	UUID(uuid)	false	none	The zoneTypeId
»»» description	string	false	none	A human readable description of the zoneType
»»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
»» id	UUID(uuid)	false	none	The zoneTypeId
»» description	string	false	none	A human readable description of the zoneType
»» category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
»» defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
»» allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.
» currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.
»» memberId	string	true	none	The memberId, a userId or a groupId.
»» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
»» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
»» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
»» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
localSynchronizationStatus	Unknown
localSynchronizationStatus	Preparing
localSynchronizationStatus	Quarantine
localSynchronizationStatus	Paused
localSynchronizationStatus	Restoring
localSynchronizationStatus	Unmapped
localSynchronizationStatus	MappingError
localSynchronizationStatus	WriteProtected
localSynchronizationStatus	InsufficientFileSystem
localSynchronizationStatus	NoDiskSpace
localSynchronizationStatus	ClockError
localSynchronizationStatus	ECMError
localSynchronizationStatus	Offline
localSynchronizationStatus	Synchronizing
localSynchronizationStatus	Synchronized
localSynchronizationStatus	Inactive
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
category	Personal
category	Normal
category	ReadProtected
defaultSynchronizationMode	Inactive
defaultSynchronizationMode	Paused
defaultSynchronizationMode	Protected
defaultSynchronizationMode	Passive
defaultSynchronizationMode	Active
defaultSynchronizationMode	All
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Leave zone

Code samples

# You can also use wget
curl -X DELETE /api/zones/{zoneid}/leave \
  -H 'Accept: application/json'

DELETE /api/zones/{zoneid}/leave

Leave the zone. If you are a zone manager and there are members left, leave is not possible unless there are at least one other zone manager. If you are zone manager and there are no other zone members, leave is possible and will result in a permanent delete of the zone and its contents. Note if you remove a user account that is the only member in a zone, the zone and its content will be removed.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none

Example responses

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get zone members

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/members \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/members

Gets members belonging to the zone with the given zone id.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	The identity of the zone to use.

Example responses

200 Response

[
  {
    "accessLevel": "Manage",
    "authorization": "Administrator",
    "displayName": "Sam Smith",
    "userId": "sam.smith@greattools.org"
  }
]

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneMember]	false	none	none
» memberId	string	true	none	The memberId, a userId or a groupId.
» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get member access level

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/members/{memberid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/members/{memberid}

Gets the member access level for the member with the given member id in the zone with the given zone id. Please consult the API documentation for additional details on how the access level is determined in cases where multiple group memberships are provided and/or when combined with explicitly set access level.

Parameters

Name	In	Type	Required	Description
memberid	path	string	true	none
zoneid	path	UUID	true	none

Example responses

200 Response

{
  "memberId": "bob@example.com",
  "accessLevel": "None",
  "displayName": "string",
  "authorization": "None",
  "memberType": "User"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» memberId	string	true	none	The memberId, a userId or a groupId.
» accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
» displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
» authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
» memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

Enumerated Values

Property	Value
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
memberType	User
memberType	Group

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Change access level

Code samples

# You can also use wget
curl -X PUT /api/zones/{zoneid}/users/{userid} \
  -H 'Accept: application/json'

PUT /api/zones/{zoneid}/users/{userid}

(Deprecated. Please use /zones/{zoneid}/members/{memberid} instead). Change the access level of a single user with the given user id for the zone with the given zone id. Note: There is a separate method to change the zone properties and change multiple member access levels at the same time.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	none
zoneid	path	UUID	true	none
accesslevel	query	AccessLevelData	false	none

Enumerated Values

Parameter	Value
accesslevel	None
accesslevel	Access
accesslevel	Add
accesslevel	Update
accesslevel	Modify
accesslevel	Manage

Example responses

200 Response

"Manage"

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get zone users

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/users \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/users

(Deprecated. Please use /zones/{zoneid}/members instead, since this method does not return any group members). Gets users belonging to the zone with the given zone id.

Parameters

Name	In	Type	Required	Description
zoneid	path	UUID	true	none

Example responses

200 Response

[
  {
    "accessLevel": "Manage",
    "authorization": "Administrator",
    "displayName": "Sam Smith",
    "userId": "sam.smith@greattools.org"
  }
]

400 Response

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ZoneUserData]	false	none	[This class is replaced by ZoneMember]
» userId	string	false	none	The userId.
» displayName	string	false	none	(Ignore for create/update operations). The displayName for the user/member
» authorization	UserAuthorizationData	false	none	(Ignore for create/update operations). The UserAuthorizationData for the user/member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
» accessLevel	AccessLevelData	false	none	The AccessLevelData for the user/member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.

Enumerated Values

Property	Value
authorization	None
authorization	Removed
authorization	Inactive
authorization	Group
authorization	Visitor
authorization	Guest
authorization	External
authorization	Internal
authorization	Manager
authorization	Administrator
authorization	Recovery
authorization	Main
accessLevel	None
accessLevel	Access
accessLevel	Add
accessLevel	Update
accessLevel	Modify
accessLevel	Manage

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Get user access level

Code samples

# You can also use wget
curl -X GET /api/zones/{zoneid}/users/{userid} \
  -H 'Accept: application/json'

GET /api/zones/{zoneid}/users/{userid}

(Deprecated. Please use /zones/{zoneid}/members/{memberid} instead). Gets the user access level for the user with the given user id in the zone with the given zone id.

Parameters

Name	In	Type	Required	Description
userid	path	string	true	none
zoneid	path	UUID	true	none

Example responses

200 Response

{
  "userId": "string",
  "accessLevelData": "None"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request executed successfully	Inline
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
406	Not Acceptable	Not Acceptable	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» userId	string	false	none	The userId
» accessLevelData	AccessLevelData	false	none	The AccessLevelData for the userId in a zone

Enumerated Values

Property	Value
accessLevelData	None
accessLevelData	Access
accessLevelData	Add
accessLevelData	Update
accessLevelData	Modify
accessLevelData	Manage

Status Code 400

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 401

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 403

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 404

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Status Code 406

Name	Type	Required	Restrictions	Description
» error	APIError	false	none	The error type, expressed as an Enum
» message	string	false	none	A descriptive error message
» data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

Enumerated Values

Property	Value
error	NONE
error	CANCELLED
error	FAILED
error	NOT_ALLOWED
error	INVALID_ACCESS
error	LOAD_ERROR
error	COMMUNICATION_ERROR
error	SERVER_NOT_RESPONDING
error	OFFLINE
error	ILLEGAL_ARGUMENTS
error	NOT_IMPLEMENTED
error	NOT_SUPPORTED
error	WRONG_ORGANIZATION
error	ORGANIZATION_UNKNOWN
error	USER_UNKNOWN
error	USER_EXISTS
error	ALREADY_LOGGED_ON
error	WRONG_PASSWORD
error	ILLEGAL_PASSWORD
error	AUTHORIZATION_FAILED
error	USER_REMOVED
error	USER_INACTIVE
error	UNKNOWN_ZONE
error	UNKNOWN_ZONE_TYPE
error	UNKNOWN_FILE
error	UNKNOWN_FILE_VERSION
error	NOT_A_FOLDER
error	NOT_A_FILE
error	ILLEGAL_NAME
error	ALREADY_EXISTS
error	NOT_AVAILABLE
error	NOT_FOUND
error	WRONG_ZONE
error	WRONG_FILE
error	LOCKED
error	TEMPORARILY_BLOCKED
error	MULTIPARTUPLOAD_FAILED
error	ASSEMBLY_FAILED
error	EXCEPTION
error	IO_EXCEPTION
error	ILLEGAL_ARGUMENT
error	TEMPORARY_FAILURE
error	PASSWORD_FAILURE
error	ID_NOT_FOUND
error	WRONG_STATE
error	UPLOAD_ID_ALREADY_EXISTS
error	VERIFICATIONCODE_FAILURE
error	TIMEOUT
error	UNSUPPORTED_VERSION

Schemas

APIError

"NONE"

Error codes that describes different failures

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Error codes that describes different failures

Enumerated Values

Property	Value
anonymous	NONE
anonymous	CANCELLED
anonymous	FAILED
anonymous	NOT_ALLOWED
anonymous	INVALID_ACCESS
anonymous	LOAD_ERROR
anonymous	COMMUNICATION_ERROR
anonymous	SERVER_NOT_RESPONDING
anonymous	OFFLINE
anonymous	ILLEGAL_ARGUMENTS
anonymous	NOT_IMPLEMENTED
anonymous	NOT_SUPPORTED
anonymous	WRONG_ORGANIZATION
anonymous	ORGANIZATION_UNKNOWN
anonymous	USER_UNKNOWN
anonymous	USER_EXISTS
anonymous	ALREADY_LOGGED_ON
anonymous	WRONG_PASSWORD
anonymous	ILLEGAL_PASSWORD
anonymous	AUTHORIZATION_FAILED
anonymous	USER_REMOVED
anonymous	USER_INACTIVE
anonymous	UNKNOWN_ZONE
anonymous	UNKNOWN_ZONE_TYPE
anonymous	UNKNOWN_FILE
anonymous	UNKNOWN_FILE_VERSION
anonymous	NOT_A_FOLDER
anonymous	NOT_A_FILE
anonymous	ILLEGAL_NAME
anonymous	ALREADY_EXISTS
anonymous	NOT_AVAILABLE
anonymous	NOT_FOUND
anonymous	WRONG_ZONE
anonymous	WRONG_FILE
anonymous	LOCKED
anonymous	TEMPORARILY_BLOCKED
anonymous	MULTIPARTUPLOAD_FAILED
anonymous	ASSEMBLY_FAILED
anonymous	EXCEPTION
anonymous	IO_EXCEPTION
anonymous	ILLEGAL_ARGUMENT
anonymous	TEMPORARY_FAILURE
anonymous	PASSWORD_FAILURE
anonymous	ID_NOT_FOUND
anonymous	WRONG_STATE
anonymous	UPLOAD_ID_ALREADY_EXISTS
anonymous	VERIFICATIONCODE_FAILURE
anonymous	TIMEOUT
anonymous	UNSUPPORTED_VERSION

AccessLevelData

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Access
anonymous	Add
anonymous	Update
anonymous	Modify
anonymous	Manage

AccountData

{
  "userName": "Bob.smith",
  "world": "",
  "organization": "fineconsultants.com",
  "displayName": "Dr. Bob Smith",
  "accountCode": ""
}

Representation of everything needed to create a user account.

Properties

Name	Type	Required	Restrictions	Description
userName	string	false	none	Unique user name within the organization, i.e the user identity name with the organization parts
world	string	false	none	The organization’s world. Set to null or empty for the Synkzone default world
organization	string	false	none	The unique organization identifier within the specified world, i.e. the organization name without any world part
displayName	string	false	none	Name of the owner of the account as it shall be displayed in user interfaces (potentially not unique)
accountCode	string	false	none	A code representation of the account that can be used to recreate the account data

AssignNewPasswordResult

{
  "ok": true,
  "newPassword": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
ok	boolean	false	none	true if a new password was assigned and distributed
newPassword	[string]	false	none	The new password, only provided if no other means to distribute the password exists

Authorization

{
  "authorizationCode": "string",
  "clientState": "string",
  "redirectURI": "string"
}

Representation of the response to a successful OAuth 2 authorize request.

Properties

Name	Type	Required	Restrictions	Description
authorizationCode	string	false	none	After successful authorization, the actual OAuth 2 response consist of a new authorization code.
clientState	string	false	none	After successful authorization, the actual OAuth 2 response consist of a client state specified in the authorization request.
redirectURI	string	false	none	A redirectionURI.

AuthorizationRequest

{
  "client_id": "string",
  "state": "string",
  "redirect_uri": "string",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "code_challenge": "string",
  "code_challenge_method": "S256",
  "tokenName": "string",
  "validity": 0,
  "clientIdentifier": "string",
  "redirectURI": "string"
}

RFC 6749

Properties

Name	Type	Required	Restrictions	Description
client_id	string	false	none	Arbitrary string defined by the authorization server to identify the type of client making the request
state	string	false	none	Arbitrary string determined by the requesting client to represent and identify the context of the returned authorization code
redirect_uri	string	false	none	redirectURI Optional URI that the response to this request should be forwarded to
scope	SPScope	false	none	Optional alternative scope for the requested access. The scope already specified for the access token is used if this parameter is left unspecified (set to null).
code_challenge	string	false	none	An optional codeChallenge according to PKCE. Set to null if not used.
code_challenge_method	string	false	none	An optional codeChallenge method, either ‘plain’ or ‘S256’
tokenName	string	false	none	A name that the user selects so that he can identify the created token and manage it.
validity	integer(int64)	false	none	Token Validity expressed in milliseconds.
clientIdentifier	string	false	none	none
redirectURI	string	false	none	none

AuthorizationRequestUserData

{
  "createdAtExpressedInGlobalTime": 0,
  "tokenName": "string",
  "clientIdentifier": "string",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "userid": {
    "name": "bob@example.com"
  },
  "validity": 0,
  "codeChallenge": "string",
  "codeChallengeMethod": "string",
  "created": 0,
  "expired": true
}

Properties

Name	Type	Required	Restrictions	Description
createdAtExpressedInGlobalTime	integer(int64)	false	none	The timestamp when the information was created, expressed in global time
tokenName	string	false	none	A name of the token used by the the user to manage his tokens
clientIdentifier	string	false	none	An identifier of the client that is using this token
scope	SPScope	false	none	The scope of the token
userid	UserId	false	none	The userId
validity	integer(int64)	false	none	The validity of the token
codeChallenge	string	false	none	An optional codeChallenge
codeChallengeMethod	string	false	none	An optional codeChallenge method
created	integer(int64)	false	none	none
expired	boolean	false	none	none

AuthorizationRequirements

{
  "passwordRequired": true,
  "canSavePassword": true,
  "otpRequired": true,
  "otpType": "None",
  "organizationName": "string",
  "worldName": "string",
  "idpData": [
    {
      "name": "AzureAD",
      "description": "Sign on with AzureAD"
    }
  ],
  "personalIdentificationTypes": [
    {
      "name": "string",
      "description": "string",
      "icon": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
passwordRequired	boolean	false	none	Specifies if a password is always required, or only required sometimes.
canSavePassword	boolean	false	none	Specifies if saving the password may be specified by the user.
otpRequired	boolean	false	none	Specifies if a one-time-password (OTP) is always required.
otpType	OTPType	false	none	Specifies the type of OTP that is required.
organizationName	string	false	none	The name of the organization that this instance belongs to.
worldName	string	false	none	The name of the world that this instance belongs to (normally Synkzone).
idpData	[IDPData]	false	none	A list of supported IDP (Identity Providers) that can be used to logon the user. If no IDPS are available the field will not be present.
personalIdentificationTypes	[PersonalIdentificationTypeData]	false	none	A list of supported personalIdentificationTypes.

ChangeableZoneData

{
  "name": "Economy",
  "description": "Internal documents",
  "type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "webAccessible": false,
  "ssiAccessible": false,
  "synkerAccessible": true,
  "allowExternalSharing": false,
  "ecmData": {
    "parameter": "string",
    "status": "string",
    "error": "string"
  },
  "members": [
    {
      "memberId": "bob@example.com",
      "accessLevel": "None",
      "displayName": "string",
      "authorization": "None",
      "memberType": "User"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the zone
description	string	false	none	A human readable description of the zone
type	string	false	none	The zone type. Either expressed as an UUID or in the human (case sensible) readable form e.g. ‘Normal’.
webAccessible	boolean	false	none	If true the zone will be accessible in the web
ssiAccessible	boolean	false	none	If true the zone will be accessible for API calls
synkerAccessible	boolean	false	none	If true the zone will be accessible for Synker clients
allowExternalSharing	boolean	false	none	If true external sharing links (shared resources) are allowed
ecmData	ECMData	false	none	(Only Applicable when External Crypto Modules are used) If provided ECM shall be activated with the included parameters
members	[ZoneMember]	false	none	A list of members with individual access levels. Ensure there is at lease one ZoneManager (AccessLevelDataDto.Manager)-

Client

"Test"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Test
anonymous	Synker
anonymous	SynkzoneSSI
anonymous	SynkzoneWeb

ClientInformation

{
  "onbAddress": "string",
  "ipAddress": "string",
  "clientType": "string",
  "clientVersion": "string",
  "accessTime": "2011-12-03T10:15:30+01:00",
  "failed": true
}

Properties

Name	Type	Required	Restrictions	Description
onbAddress	string	false	none	The ONBNode address of the client
ipAddress	string	false	none	The IP address of the client
clientType	string	false	none	The client type
clientVersion	string	false	none	The client version
accessTime	string	false	none	The accesstime of the log on in ISO-8601 extended offset date-time format.
failed	boolean	false	none	If true the logon was a failed logon attempt.

ClientInformation1

{
  "onbAddress": "string",
  "ipAddress": "string",
  "clientType": "string",
  "clientVersion": "string",
  "accessTime": 0,
  "failed": true
}

Properties

Name	Type	Required	Restrictions	Description
onbAddress	string	false	none	none
ipAddress	string	false	none	none
clientType	string	false	none	none
clientVersion	string	false	none	none
accessTime	integer(int64)	false	none	none
failed	boolean	false	none	none

ConfirmNotification

{
  "id": 0,
  "response": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	A unique ID for this particular event.
response	boolean	false	none	The response for this particular event.

Credentials

{
  "password": [
    "a",
    "b",
    "c"
  ],
  "verificationCode": "123700"
}

Properties

Name	Type	Required	Restrictions	Description
password	[string]	false	none	A password to use for revalidation
verificationCode	string	false	none	A verificationcode to use for revalidation

ECMData

{
  "parameter": "string",
  "status": "string",
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
parameter	string	false	none	The ECM parameter for a zone that uses ECM
status	string	false	none	Current ECM status for the zone
error	string	false	none	ECM function error message

ErrorMessage

{
  "error": "NONE",
  "message": "example_of_failure",
  "data": "62a1b26a-3f03-4ce9-b028-d85a361a872b"
}

Properties

Name	Type	Required	Restrictions	Description
error	APIError	false	none	The error type, expressed as an Enum
message	string	false	none	A descriptive error message
data	string	false	none	An optional data element, such as a fileID, multipartuploadId or similar

ExtendedUserInformationData

{
  "userId": "string",
  "displayName": "string",
  "active": true,
  "removed": true,
  "externalUserName": "string",
  "personalData": {
    "realName": "Bob Johnson",
    "emailAddresses": "bob@goodtools.com",
    "preferredLanguageCode": "en"
  },
  "passwordChangeRequired": false,
  "authorization": "None",
  "hiddenPassword": true,
  "password": [
    "string"
  ],
  "actions": {
    "changePersonalData": true,
    "changeAuthorizationData": true,
    "changeExternalId": true,
    "allowedAuthorizations": [
      "None"
    ],
    "assignNewCredentials": true,
    "canDeactivate": true,
    "canReactivate": true,
    "canRemove": true,
    "canSetPersonalIdentity": true,
    "canGetPersonalIdentity": true,
    "canRemovePersonalIdentity": true,
    "canHide": true,
    "canUnhide": true,
    "canGetSignOnHistory": true
  },
  "verifiedName": "string",
  "hidden": true,
  "createableUserAccountTypes": [
    "Guest",
    "External",
    "Internal",
    "Manager"
  ],
  "createableZoneTypes": [
    {
      "description": "Personal",
      "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
    },
    {
      "description": "Normal",
      "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
    },
    {
      "description": "Read protected",
      "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
    }
  ],
  "groups": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2011-12-03T10:15:30+01:00",
  "createdBy": "string",
  "removedAt": "2011-12-03T10:15:30+01:00",
  "removedBy": "string",
  "assignedCredentialsAt": "2011-12-03T10:15:30+01:00",
  "assignedCredentialsBy": "string",
  "tenantId": "string",
  "tenantName": "string",
  "sessionExpiryIn": 0
}

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
displayName	string	false	none	A (calculated) name to use for display purposes.
active	boolean	false	none	If the user account is active or not.
removed	boolean	false	none	If the user account is removed or not.
externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
passwordChangeRequired	boolean	false	none	If true user should be required to change password
authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
actions	UserActions	false	none	A list of actions that the user can do.
verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
» additionalProperties	string(uuid)	false	none	none
createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
createdBy	string	false	none	A userID of the user that created this account
removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
removedBy	string	false	none	A userID of the user that removed this account
assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
tenantId	string	false	none	The tenantId if the user belongs to a tenant
tenantName	string	false	none	The tenantName if the user belongs to a tenant
sessionExpiryIn	integer(int64)	false	none	The validity of the current session expressed in milliseconds

FieldContentType

"General"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	General
anonymous	Number
anonymous	Date

FieldData

{
  "name": "string",
  "description": "string",
  "type": "General",
  "required": true,
  "validContents": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the field, to be presented in forms. This must be a non-empty string. Any leading or trailing white space will be trimmed away.
description	string	false	none	Optional free text description of the field, its purpose, etc.,to be used as hint/help when filling in instances of the field.
type	FieldContentType	false	none	The type of content intended for this field, which may be used to validate any value entered into the field. This must always be specified.
required	boolean	false	none	Specifies if this field must be assigned non-empty value or not.
validContents	[string]	false	none	Optional list of values or value patterns that may be entered in this field. If not specified, or empty, any value will be accepted. Otherwise, only values in this list are to be considered valid for this field. May be used in forms to show a selection of valued to choose from. Each value is specified as a regular expression so it is possible to specify not only fixed values, but also value patterns.

FrameworkStatus

{
  "authorizationMappingHTSize": 0,
  "ONBNode": "string",
  "userControllerSize": 0,
  "client": "string",
  "htAuthorizationMappingHTSize": 0,
  "oNBNode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
authorizationMappingHTSize	integer(int32)	false	none	none
ONBNode	string	false	none	The ONBNode Identity
userControllerSize	integer(int32)	false	none	none
client	string	false	none	Client type
htAuthorizationMappingHTSize	integer(int32)	false	none	none
oNBNode	string	false	none	none

GroupAccessLevel

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Access
anonymous	Manage

GroupActions

{
  "assignAccessRights": true
}

Class used to to describe what actions a user is allowed to do.

Properties

Name	Type	Required	Restrictions	Description
assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self

GroupData

{
  "properties": {
    "groupId": "string",
    "externalId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2011-12-03T10:15:30+01:00",
    "createdBy": "string",
    "allowedActions": {
      "assignAccessRights": true
    },
    "administratorManaged": true,
    "open": true,
    "zoneActions": {
      "assignAccessRights": true
    }
  },
  "members": [
    {
      "memberId": "string",
      "displayName": "string",
      "authorization": "None",
      "accessLevel": "None",
      "memberType": "User"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
properties	GroupProperties	false	none	A collection of properties for the group.
members	[GroupMember]	false	none	The list of members in the group.

GroupInData

{
  "name": "string",
  "description": "string",
  "externalId": "string",
  "members": [
    {
      "memberId": "string",
      "accessLevel": "None"
    }
  ],
  "administratorManaged": true,
  "open": true
}

Class used to create and update Groups. To query existing groups the class GroupDataDto will be returned.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the group.
description	string	false	none	The description of the group.
externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
members	[GroupMemberIn]	false	none	The list of members in the group.
administratorManaged	boolean	false	none	(NOTE support for true is BETA feature) (Immutable, cannot be changed) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
open	boolean	false	none	(NOTE support for false is BETA feature) Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.

GroupMember

{
  "memberId": "string",
  "displayName": "string",
  "authorization": "None",
  "accessLevel": "None",
  "memberType": "User"
}

Class that represents a Group member.

Properties

Name	Type	Required	Restrictions	Description
memberId	string	false	none	none
displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
accessLevel	GroupAccessLevel	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
memberType	MemberType	false	none	(Only output. Ignore for create/update operations) The member type, whether this member is a user or a group.

GroupMemberIn

{
  "memberId": "string",
  "accessLevel": "None"
}

Class used to create and update Group members. To query existing group members the class GroupMemberDto will be returned.

Properties

Name	Type	Required	Restrictions	Description
memberId	string	false	none	The memberId. The memberId expressed as a UserId or as a groupId.
accessLevel	GroupAccessLevel	false	none	The AccessLevelData for the member, such as None, Access or Manage. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.

GroupProperties

{
  "groupId": "string",
  "externalId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2011-12-03T10:15:30+01:00",
  "createdBy": "string",
  "allowedActions": {
    "assignAccessRights": true
  },
  "administratorManaged": true,
  "open": true,
  "zoneActions": {
    "assignAccessRights": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	false	none	The id of the group.
externalId	string	false	none	Identifier for this group with an external IDP, which can be used for user database synchronization.
name	string	false	none	The name of the group.
description	string	false	none	A description of the group.
createdAt	string	false	none	Date when the group was created, expressed in ISO8601 extended offset date-time format.
createdBy	string	false	none	Name of the user that created the zone.
allowedActions	GroupActions	false	none	The actions that the current user can perform on the group.
administratorManaged	boolean	false	none	(Immutable) Whether this group is administrator managed, i.e. can have management without content access be done by administrators. In a zone that is AdministratorManaged, any administrator can act as zone manager. This property is set at group creation and cannot be changed.
open	boolean	false	none	Whether this group is open, i.e. allows any user to see who is a member. In a group that is open, any user can see who is a member of the group as long as it is a coworker. In a group that is not open, only group managers and other members can see who is a member.
zoneActions	GroupActions	false	none	Class used to to describe what actions a user is allowed to do.

IDPData

{
  "name": "AzureAD",
  "description": "Sign on with AzureAD"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	IDP Name.
description	string	false	none	A description of the IDP.

LogonRequest

{
  "username": "bob@happyday.com",
  "password": [
    "a",
    "b",
    "c",
    "1"
  ],
  "passwordAsString": "password123",
  "verificationCode": "177600",
  "setCookie": true,
  "sameSitePolicy": "Strict",
  "scope": "\"User=bob@example.com\":{\"get\":true}",
  "timeout": 600000,
  "timeoutInSeconds": 600,
  "acceptSessions": false,
  "logonSessionId": "1679664938247",
  "token": "",
  "savePassword": false,
  "organizationName": "happyorg.com",
  "autoLogon": true
}

A request to logon, using either credentials or an IDP flow. Can be used for normal ‘stateless’ logon flows (default) or in ‘session-based-logon-flows’.

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	The username. (Required unless a token is used to identify the user).
password	[string]	false	none	The password.
passwordAsString	string	false	none	Note: The passwordAsString field is optional and should only be used if providing the password as a char[] is not feasible. However, it’s strongly recommended to avoid using String for passwords, as char[] is more secure. This is because String objects are immutable and may remain in memory longer, increasing the risk of exposure.
verificationCode	string	false	none	The verificationcode if needed. Used in 2 Factor authentication.
setCookie	boolean	false	none	If true and logon is successfull set the sessionId in a cookie.
sameSitePolicy	string	false	none	If successfull logon and setCookie=true, use this SameSite policy. Allowed values are: Strict, Lax, and None. Strict ensures the cookie is sent only with same-site requests. Lax allows the cookie with top-level navigations and some cross-site requests. None allows the cookie with all cross-site requests but requires the Secure attribute.
scope	SPScope	false	none	An optional scope (a scope is normally not required at logon).
timeout	integer(int64)	false	none	(Deprecated) A requested validity in milliseconds of the logon. Note this field is deprecated, please use timeoutInSeconds
timeoutInSeconds	integer(int64)	false	none	A requested validity in seconds of the logon.
acceptSessions	boolean	false	none	Only used in session-based-logon-flows. If true a logon flow may be continued and credentials may be supplied on a per demand basis. if false all credentials must be available in the first call. Usage: When a LogonSessionStateis returned, it includes a sessionId and state that describes what information that is missing (e.g. passsword). Include the returned sessionId in a new LogonRequest in field logonSessionId in order to continue the ongoing request instead of cancelling it. If a logon is successfull a LogonResult is returned. If failed permanently (session may not be continued) an ErrorMessage is returned. Note: Most logon flows do not require the usage of ‘session-based-logon-flows’, these flows are used when it is unclear what credentials that must be provided.
logonSessionId	string	false	none	(Only used in session-based-logon-flows). An optional session identifier. Used if this request is a continuation of an existing logon flow rather than a new call.
token	string	false	none	(Only relevant for IDP login). A token or an authorization string if a token based signon or IDP based sign on is used.
savePassword	boolean	false	none	(Only relevant for synchronizing Desktop clients). An optional indication that the user want to save the password locally.
organizationName	string	false	none	(Only relevant for synchronizing clients (e.g. desktop), but in this case required). The name of the organization (including world if using non default).
autoLogon	boolean	false	none	(Only relevant for synchronizing clients (e.g. desktop). If true enable autoLogon. Note: Only applicable for logon policies where this is possible.

LogonResult

{
  "logonOK": true,
  "sessionId": "string",
  "expiresInMillis": 600000,
  "idpURI": "http://example.com",
  "passwordChangeIsRequired": false,
  "userId": {
    "name": "bob@example.com"
  }
}

Returned as a response to a successfull LogonRequest.

Properties

Name	Type	Required	Restrictions	Description
logonOK	boolean	true	none	True if logon was successfull. Please check field passwordChangeIsRequired to determine if the password needs to be changed.
sessionId	string	false	none	The sessionId, which can be used as authentication for further calls. It is set in a cookie if setCookie=true was set in the LogonRequest. Provide the cookie in further calls or use the Authorization HTTP header like this Authorization: Bearer sessionId
expiresInMillis	integer(int64)	false	none	The sessionId timeout in milliseconds. If you do not want to actively keep the session alive you should set a large enough expiry.
idpURI	string(uri)	false	none	Request that an IDP URI is opened in a web browser to allow the user to authenticate and authorize with an IDP.
passwordChangeIsRequired	boolean	false	none	If true the user is required to change password immediately and no other operations are allowed before this is done. IMPORTANT NOTE only ‘change password’ endpoint is reachable in this case!
userId	UserId	false	none	The userId related to the result.

LogonSessionState

{
  "state": "PASSWORDPENDING",
  "sessionId": "string",
  "userId": {
    "name": "bob@example.com"
  }
}

This message is returned when ‘session-based-logon-flows’ are used. It is used to describe what credentials that needs to be provided in order to continue a logon flow. To use ‘session-based-logon-flows’ set acceptSessions=true in LogonRequest message.

Properties

Name	Type	Required	Restrictions	Description
state	State	false	none	The current state. Describes what credentials that needs to be provided
sessionId	string	false	none	The sessionId, which can be used to continue a session in further calls. Send this sessionId in the logonSessionId field in the LogonRequest message.
userId	UserId	false	none	The userId related to the result.

MemberType

"User"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	User
anonymous	Group

MessageData

{
  "createdAt": "string",
  "id": 0,
  "userId": "string",
  "zoneId": "string",
  "messageTypeId": "string",
  "title": "string",
  "message": "string",
  "timeout": 0,
  "defaultResponse": true,
  "assignedPassword": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	Timestamp in the local platform time when the message was created
id	integer(int64)	false	none	A unique ID for this particular event.
userId	string	false	none	The userId.
zoneId	UUID	false	none	The zoneId.
messageTypeId	string	false	none	A unique name for the type of message, which may be used to match the request to already prepared responses.
title	string	false	none	A message title which for example can be used as a dialog title or other header The title text is translated to the user’spreferred language (if translations exist).
message	string	false	none	The message text, translated to the user’s preferred language (if translations exist).
timeout	integer(int64)	false	none	Maximum time in milliseconds to wait for a response, Zero or negative means to wait indefinitely
defaultResponse	boolean	false	none	A default Response
assignedPassword	[string]	false	none	The assigned Password, note: used only under specific circumstances

MultiPart

{
  "partNumber": 1,
  "partMd5": "string",
  "length": 0
}

Properties

Name	Type	Required	Restrictions	Description
partNumber	integer(int32)	false	none	The partnumber
partMd5	string	false	none	The MD5 checksum of this part
length	integer(int64)	false	none	The number of bytes of this part

MultiPartBody

{
  "file": "string",
  "filename": "string",
  "fileid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
file	string(binary)	true	none	The contents of the file expressed as an inputStream
filename	string	true	none	The name of the file
fileid	string	false	none	The zoneFileId if the upload is expected to create a new version of an existing file, or null if the file is new.

MultiPartInitRequest

{
  "fileid": "string",
  "fileName": "string",
  "lastModified": "",
  "zoneFileAttributesData": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  },
  "allowOverwrite": true
}

Data to initiate a Multipart upload request

Properties

Name	Type	Required	Restrictions	Description
fileid	string	false	none	An optional fileId (or an URLEncoded path to the file), to create a new version of the file instead of a new file.
fileName	string	true	none	The name of the file.
lastModified	string	false	none	The modification date and time of the file (in ISO8601). If not set, current global time is used.
zoneFileAttributesData	ZoneFileAttributes	false	none	File attributes of the file.
allowOverwrite	boolean	false	none	If a fileid is not specified and there is a matching file (a file with than name in the folder) a new version can be added by by setting this to true.

MultiPartSupportBody

{
  "file": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
file	string(binary)	false	none	The contents of an optional file (e.g. screenshot) expressed as an inputStream. Note the file field must exist but can be empty (example: ‘file=’)
description	string	false	none	A description of the fault.

MultiPartUpload

{
  "parts": [
    {
      "partNumber": 1,
      "partMd5": "string",
      "length": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
parts	[MultiPart]	false	none	An array of parts

MultipartUploadInit

{
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	UUID	true	none	The id of a MultiPartUpload.

NeededField

"username"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	username
anonymous	password
anonymous	verificationCode
anonymous	idpRequest
anonymous	token

NewCredentials

{
  "message": "string"
}

A class used when a user looses his password and wants to request a new one.

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none

NewFolder

{
  "newFolderName": "string",
  "attributes": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
newFolderName	string	false	none	The new folder name
attributes	ZoneFileAttributes	false	none	The new ZoneFileAttributesData to set

NewPasswordRequest

{
  "oldPassword": [
    "a",
    "b",
    "c"
  ],
  "newPassword": [
    "1",
    "2",
    "3"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
oldPassword	[string]	false	none	The old password
newPassword	[string]	false	none	The new password

NewTokenRequest

{
  "tokenName": "string",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "validity": 0,
  "password": [
    "a",
    "b",
    "c",
    "1"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
tokenName	string	false	none	The Name of the token, can be used to manage the token but not use it
scope	SPScope	false	none	The Scope of the token, can be used to limit the authorization of the token
validity	integer(int64)	false	none	The requested token validity in seconds
password	[string]	false	none	The password (if a logon policy that requires password is used)

OAuth2ClientRegistrationData

{
  "client_id": "3c011353-a9e7-4e3b-12c3-6d6d2ad02931",
  "client_secret": "F808710FDD3340A1807920187FF68994DDD6A79100000185173CE43C87B61A5E",
  "client_id_issued_at": 2893256800,
  "client_secret_expires_at": 2893276800,
  "registrationClientURI": "string",
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "clientIdentifier": "string",
  "clientSecret": "string",
  "clientIdentifierIssuedAt": 0,
  "clientSecretExpiresAt": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Oauth2 Client Data according to DCRM.

RFC 7591

Properties

Name	Type	Required	Restrictions	Description
client_id	string	true	none	OAuth 2.0 client identifier string. Assigned by authorization server.
client_secret	string	false	none	The client secret (OAuth 2.0 client secret string). Needed when client is created/registered first time. Authorization server supplied secret to use for token access
client_id_issued_at	integer(int64)	false	none	When the client was registered. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
client_secret_expires_at	integer(int64)	true	none	When the issued client secret validity expires. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
registrationClientURI	string	false	none	Assigned by authorization server on registration. Same as the registration URI + /.
token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
redirect_uris	[string]	false	none	URI for redirect of authorization responses
client_name	string	false	none	Human readable name of the client
client_uri	string	false	none	Link to client information page to display during authorization
logo_uri	string	false	none	Link to client logo to display during authorization
contacts	[string]	false	none	How to contact client supplier
tos_uri	string	false	none	Link to terms of service to display during authorization
policy_uri	string	false	none	Link to privacy policy to display during authorization
software_id	string	false	none	Client supplier’s unique id for the client
software_version	string	false	none	Client supplier’s software version number
scopes	[SPScope]	false	none	Scopes that the client are allowed to use
token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
clientIdentifier	string	false	none	none
clientSecret	string	false	none	none
clientIdentifierIssuedAt	integer(int64)	false	none	none
clientSecretExpiresAt	integer(int64)	false	none	none
tokenEndpointAuthorizationMethod	string	false	none	none
grantTypes	[string]	false	none	none
responseTypes	[string]	false	none	none
redirectURIs	[string]	false	none	none
clientName	string	false	none	none
clientURI	string	false	none	none
logoURI	string	false	none	none
tosURI	string	false	none	none
policyURI	string	false	none	none
softwareId	string	false	none	none
softwareVersion	string	false	none	none

OAuth2ClientRegistrationInData

{
  "token_endpoint_auth_method": "client_secret_basic",
  "grant_types": "authorization_code",
  "response_types": "code",
  "redirect_uris": "https://client.example.org/callback",
  "client_name": "Photo Quality Printer",
  "client_uri": "https://client.example.net/",
  "logo_uri": "string",
  "contacts": [
    "string"
  ],
  "tos_uri": "string",
  "policy_uri": "string",
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "string",
  "scopes": [
    {
      "name": "string",
      "description": "string",
      "clients": [
        "Test"
      ],
      "permissions": {
        "property1": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        },
        "property2": {
          "all": true,
          "create": true,
          "list": true,
          "get": true,
          "access": true,
          "modify": true,
          "delete": true
        }
      },
      "limitations": {
        "property1": null,
        "property2": null
      },
      "extensions": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "token": "string",
  "tokenExpiry": 0,
  "tokenEndpointAuthorizationMethod": "string",
  "grantTypes": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "redirectURIs": [
    "string"
  ],
  "clientName": "string",
  "clientURI": "string",
  "logoURI": "string",
  "tosURI": "string",
  "policyURI": "string",
  "softwareId": "string",
  "softwareVersion": "string"
}

Data needed to register an Oauth2 Client according to DCRM, RFC7591.

RFC 7591

Properties

Name	Type	Required	Restrictions	Description
token_endpoint_auth_method	string	false	none	We only accept ‘client_secret_basic’ in our case, and will set to that if omitted
grant_types	[string]	false	none	We only accept ‘authorization_code’ in our case, and will set to that if omitted
response_types	[string]	false	none	We only accept ‘code’ in our case, and will set to that if omitted
redirect_uris	[string]	false	none	URI for redirect of authorization responses
client_name	string	false	none	Human readable name of the client
client_uri	string	false	none	Link to client information page to display during authorization
logo_uri	string	false	none	Link to client logo to display during authorization
contacts	[string]	false	none	How to contact client supplier
tos_uri	string	false	none	Link to terms of service to display during authorization
policy_uri	string	false	none	Link to privacy policy to display during authorization
software_id	string	false	none	Client supplier’s unique id for the client
software_version	string	false	none	Client supplier’s software version number
scopes	[SPScope]	false	none	Scopes that the client are allowed to use
token	string	false	none	Registration access token. Token that can be used in Authorization header to manage this specific client.
tokenExpiry	integer(int64)	false	none	Expiry timestamp of the registration access token. Expressed as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of issuance.
tokenEndpointAuthorizationMethod	string	false	none	none
grantTypes	[string]	false	none	none
responseTypes	[string]	false	none	none
redirectURIs	[string]	false	none	none
clientName	string	false	none	none
clientURI	string	false	none	none
logoURI	string	false	none	none
tosURI	string	false	none	none
policyURI	string	false	none	none
softwareId	string	false	none	none
softwareVersion	string	false	none	none

OTPType

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	TOTP
anonymous	HOTP
anonymous	SynkzoneMail

OrganizationData

{
  "name": "example.org",
  "created": "2011-12-03T10:15:30+01:00",
  "webServiceAddress": "",
  "ssiServiceAddress": "",
  "synkerUpdateURL": "",
  "displayName": "Unity Enterprises",
  "iconURI": "https://www.unityenterprises.com/ui/logoSmall.gif",
  "signOnInfo": "This system is for authorized users only. Unauthorized access is prohibited. Any unauthorized use may result in legal action.",
  "status": "Registered."
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name (Unique identifier) of the organization
created	string	false	none	The creation timestamp of the organization as ISO-8601 extended offset date-time format
webServiceAddress	string	false	none	The host address of the web service if such exists
ssiServiceAddress	string	false	none	The host address of the SSI (API) service if such exists
synkerUpdateURL	string	false	none	The address where client updates are distributed
displayName	string	false	none	Optional name to use instead of the identifier when displaying or referring the organization in end user interaction
iconURI	string	false	none	Optional specification for how and where to get logos and/or other icons to use when displaying the organization in end user interaction
signOnInfo	string	false	none	Optional information to shown to users who attempt to sign on to the organization, such as specific instructions or legal information
status	OrganizationStatus	false	none	Representation of the current status of an organization: Registered: The organization has registered settings within its world, so it should be ready to access. Unregistered: No registered settings for the organization can be found, so may be either removed or waiting to be registered.

OrganizationPolicies

{
  "allowExtraAdministrators": true,
  "allowAdminCredentialsAssignment": false,
  "preventClientDataUpload": false,
  "preventServerDataUpload": false,
  "allowExternalUserZoneCreation": false,
  "requireAdministratorForZoneCreation": false,
  "maxPersonalZoneSize": "107_374_182_400",
  "maxNumberOfPersonalZones": 4,
  "minimumPasswordLength": 8,
  "passwordTimeoutInDays": 1,
  "passwordReminderIntervalInDays": 604800000,
  "enforceOldPasswordChange": false,
  "enforceNewPasswordChange": false,
  "signOnPolicy": "Local",
  "idpType": "None",
  "idpClientIdentifier": "",
  "idpOrganizationIdentifier": "",
  "personalIdentificationTypes": [
    {
      "name": "string",
      "description": "string",
      "icon": "string"
    }
  ],
  "allowInternalUsersToSeeNonHiddenUsers": true,
  "autoCreateIDPUsers": false,
  "enableGroups": false,
  "enableTenants": false,
  "sspDataFields": [
    {
      "name": "string",
      "description": "string",
      "type": "General",
      "required": true,
      "validContents": [
        "string"
      ]
    }
  ]
}

Main Administrator Guide

Properties

Name	Type	Required	Restrictions	Description
allowExtraAdministrators	boolean	false	none	This is a setting that permits other users than the main administrator to act as an administrator.
allowAdminCredentialsAssignment	boolean	false	none	Allow administrators to reset the main administrator credentials.
preventClientDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text.
preventServerDataUpload	boolean	false	none	If true client status data can be shared with Synkzone if technical support is needed. The information sent contains only data that can be used to perform technical support and in no case any data or information in clear text."
allowExternalUserZoneCreation	boolean	false	none	If true, external users may create private zones.
requireAdministratorForZoneCreation	boolean	false	none	If true internal users may not create zones, only administrators may.
maxPersonalZoneSize	integer(int64)	false	none	The maximum cleartext size for a personal zone.
maxNumberOfPersonalZones	integer(int32)	false	none	The maximum number of personal zones.
minimumPasswordLength	integer(int32)	false	none	The minimum password length.
passwordTimeoutInDays	integer(int64)	false	none	The expiry time for passwords.
passwordReminderIntervalInDays	integer(int64)	false	none	The frequency for reminding the user to change her password.
enforceOldPasswordChange	boolean	false	none	If true the user will be forced to change an expired old password.
enforceNewPasswordChange	boolean	false	none	If true the user will be forced to change a newly generated password with her own password.
signOnPolicy	SignOn	false	none	The organization sign on policy to be used
idpType	string	false	none	The type of IDP to use. This can be selected from a list of IDPs that Synkzone currently supports. Currently support is available for ‘None’ and ‘AzureAD’
idpClientIdentifier	string	false	none	The client identifier registered for your Synkzone organization with the IDP.
idpOrganizationIdentifier	string	false	none	The identifier for your organization as registered with the IDP.
personalIdentificationTypes	[PersonalIdentificationTypeData]	false	none	The personalIdentificationTypes used by the organisation.
allowInternalUsersToSeeNonHiddenUsers	boolean	false	none	If true allow internal users to see all other internal users, not only coworkers (users you share zones with).
autoCreateIDPUsers	boolean	false	none	Determine if previously unknown IDP user identities shall get automatically created Synkzone accounts.
enableGroups	boolean	false	none	Activate support for Group feature.
enableTenants	boolean	false	none	Activate support for Tenant feature.
sspDataFields	[FieldData]	false	none	SSP settings.

OrganizationStatus

"Registered"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Registered
anonymous	Unregistered

PasswordShareProtection

{
  "password": 1234,
  "type": "PASSWORD"
}

Properties

Name	Type	Required	Restrictions	Description
password	[string]	false	none	A password or PIN protecting the shared resource. Rules: - Must be at least 4 characters long. - Must not start or end with whitespace (space, tab, CR, LF, form-feed, etc.).
type	string	false	none	The type of protection

Enumerated Values

Property	Value
type	PASSWORD

Path

{
  "path": "/folder22/hello.txt"
}

Properties

Name	Type	Required	Restrictions	Description
path	string	false	none	A path and a filename to search for

Permission

{
  "all": true,
  "create": true,
  "list": true,
  "get": true,
  "access": true,
  "modify": true,
  "delete": true
}

Properties

Name	Type	Required	Restrictions	Description
all	boolean	false	none	none
create	boolean	false	none	none
list	boolean	false	none	none
get	boolean	false	none	none
access	boolean	false	none	none
modify	boolean	false	none	none
delete	boolean	false	none	none

PersonalIdentificationTypeData

{
  "name": "string",
  "description": "string",
  "icon": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the Personal Identification Type
description	string	false	none	A description of the Personal Identification Type
icon	string(binary)	false	none	An icon that represents the Personal Identification Type

PersonalIdentityData

{
  "personalIdentityType": "SwedishPersonalNumber",
  "personalIdentity": "200001042381"
}

A class to hold the ‘Personal Identity’ of a user, that can be used for identity based sign on.

Properties

Name	Type	Required	Restrictions	Description
personalIdentityType	Type	false	none	The type of personal identity as defined by PersonalIdentityType: Unknown, SwedishPersonalNumber
personalIdentity	string	false	none	The personal identity according to the specified type

PlatformNotification

{
  "subject": "string",
  "data": {
    "createdAt": "string",
    "id": 0,
    "userId": "string",
    "zoneId": "string",
    "messageTypeId": "string",
    "title": "string",
    "message": "string",
    "timeout": 0,
    "defaultResponse": true,
    "assignedPassword": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
subject	string	false	none	The subject
data	MessageData	false	none	The MessageData

ProtectionType

"PASSWORD"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	PASSWORD
anonymous	NONE

ResourceMultiPartBody

{
  "file": "string",
  "filename": "string"
}

Properties

Name	Type	Required	Restrictions	Description
file	string(binary)	true	none	The contents of the file expressed as an inputStream
filename	string	true	none	The name of the file

RevalidateInformation

{
  "passwordDuration": 0,
  "verificationCodeDuration": 0,
  "revalidateTimeout": 0,
  "expectedField": "password"
}

Properties

Name	Type	Required	Restrictions	Description
passwordDuration	integer(int64)	false	none	The number of milliseconds before a password revalidate expires.
verificationCodeDuration	integer(int64)	false	none	The number of milliseconds before a verification code revalidate expires.
revalidateTimeout	integer(int64)	false	none	The default expiry timeout for revalidation.
expectedField	RevalidateNeededField	true	none	The expected field to be supplied for revalidation.

RevalidateNeededField

"unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	unknown
anonymous	password
anonymous	verificationCode
anonymous	none

SPScope

{
  "name": "string",
  "description": "string",
  "clients": [
    "Test"
  ],
  "permissions": {
    "property1": {
      "all": true,
      "create": true,
      "list": true,
      "get": true,
      "access": true,
      "modify": true,
      "delete": true
    },
    "property2": {
      "all": true,
      "create": true,
      "list": true,
      "get": true,
      "access": true,
      "modify": true,
      "delete": true
    }
  },
  "limitations": {
    "property1": null,
    "property2": null
  },
  "extensions": {
    "property1": null,
    "property2": null
  }
}

A Scope defines a set of Permisssions and a set of Limitations that is used to determine within some context whether certain operations or other actions shall be allowed or not within that context.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	A user friendly name of the scope. There are some reserved special scopes, if these names are used standard scopes will be used and other supplied fields ignored. The standard scopes are SynkzoneSynker (Desktop client), SynkzoneSSI or SynkzoneAPI (API Usage), SynkzoneWeb, SCIM (User management), Logreader, Authenticate
description	string	false	none	A user friendly description of the scope.
clients	[Client]	true	none	The client type(s) where this scope is valid.
permissions	object	false	none	A Set of Permissions that maps Category and Object to Permission.
» additionalProperties	Permission	false	none	none
limitations	object	false	none	Limitations define specific circumstances under which a Scope is to be considered valid, such as the type of client where it is used, when it is used, or from where it is used. Examples are Client use, Source address and Calendar
» additionalProperties	any	false	none	none
extensions	object	false	none	For future usage.
» additionalProperties	any	false	none	none

SelectableIDP

{
  "selectableIDPs": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
selectableIDPs	[string]	false	none	An array of selectable IDP names.

ShareAuthorization

{
  "myType": "userAndPassword",
  "userAndAuth": [
    {
      "shareRecipient": {
        "displayName": "christer",
        "userName": "christer@example.com",
        "internalIdentifier": "abc123",
        "shareInformationRecipientIdentifierType": "none",
        "shareInformationRecipientIdentifier": ""
      },
      "shareRecipientAuthorization": {
        "shareRecipientAuthorizationType": "password",
        "shareRecipientAuthorization": "aSecretPassword!"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
myType	ShareAuthorizationType	true	none	The type of authorization required.
userAndAuth	[UserAndAuth]	false	none	List of users and their authorization.

ShareAuthorizationType

"none"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	none
anonymous	userAndPassword
anonymous	userAndAuth

ShareAuthorizationType1

"none"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	none
anonymous	userAndPassword
anonymous	userAndAuth

ShareInformation

{
  "shareID": "string",
  "name": "string",
  "link": "string",
  "createdAt": "2011-12-03T10:15:30+01:00",
  "validFrom": "2011-12-03T10:15:30+01:00",
  "validUntil": "2011-12-05T10:15:30+01:00",
  "userId": {
    "name": "bob@example.com"
  },
  "state": "OK",
  "usageReport": [
    {
      "user": "chris@example.com",
      "ipHeader": "212.193.12.123",
      "fileId": "B79542DAB6D64F1682F530F9C9AA7E36EC167F9C0000018016E7963799053C10",
      "versionTimeStamp": "2023-04-11T18:06:12.056+02:00",
      "type": "download",
      "timeStamp": "2011-12-03T10:15:30+01:00"
    }
  ],
  "shareAuthorizationType": "none",
  "protectionType": "PASSWORD",
  "recipients": [
    "string"
  ],
  "spScope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "messageText": "string",
  "shareURI": "string",
  "errorMessage": "string"
}

Basic Information about the share.

Properties

Name	Type	Required	Restrictions	Description
shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
name	string	false	none	The (non secret) name of the share that is used for display and manage purposes.
link	string	false	none	The secret link created that is to be provided to the recipient. This link is only available if the share accepts anonymous users.
createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
validFrom	string	false	none	The timestamp when the share will start to be valid. (ISO-8601 extended offset date-time format).
validUntil	string	false	none	The validity of the share (ISO-8601 extended offset date-time format).
userId	UserId	false	none	The creator of the share.
state	ShareState	false	none	The state of the share.
usageReport	[UsageReport]	false	none	Information about how the share has been used e.g. download/upload.
shareAuthorizationType	ShareAuthorizationType1	false	none	The required authorization to access as a recipient of this share.
protectionType	ProtectionType	false	none	The required protection type to access as a recipient of this share.
recipients	[string]	false	none	A list of e-mail adresses (or other valid identifier used in the authorization process) to identify the recipients of this share.
spScope	SPScope	false	none	The shared resource expressed as a scope (May not be available when listing ShareInformation).
messageText	string	false	none	A message text attached to the share that is displayed for the recipient. If the share information is sent by an e-mail this information may be included.
shareURI	string	false	none	The complete URI of the Shared Resource to be used by the recipient (not always available when retrieving the share).
errorMessage	string	false	none	A description of an error if such exists.

ShareProtection

{
  "type": "NONE"
}

Base class for protected shares. Specific protections will need to subclass ShareProtectionDto, e.g. PasswordShareProtectionDto

Properties

Name	Type	Required	Restrictions	Description
type	ProtectionType	false	none	The type of protection, NONE is default

ShareRecipient

{
  "displayName": "Niclas Smith",
  "userName": "niclas@example.com",
  "internalIdentifier": "abc123",
  "shareInformationRecipientIdentifierType": "email",
  "shareInformationRecipientIdentifier": "niclas@example.com",
  "sharePasswordRecipientIdentifierType": "email",
  "sharePasswordRecipientIdentifier": "niclas@example.com"
}

Properties

Name	Type	Required	Restrictions	Description
displayName	string	false	none	The name of the recipient that shall be displayed.
userName	string	false	none	The name or identifier of the recipient that shall be used in a UI which authorization is matched against.
internalIdentifier	string	false	none	An optionalt identifier to be used when referencing to this user from another system.
shareInformationRecipientIdentifierType	ShareRecipientIdentifierType	false	none	Information about how (the type) the share shall be communicated to the recipient.
shareInformationRecipientIdentifier	string	false	none	Information about how the share shall be communicated to the recipient, example could be the e-mail address of the recipient.
sharePasswordRecipientIdentifierType	ShareRecipientIdentifierType	false	none	Information about how (the type) the password of the share shall be communicated to the recipient.
sharePasswordRecipientIdentifier	string	false	none	Information about how the password of the share shall be communicated to the recipient.

ShareRecipientAuthorization

{
  "shareRecipientAuthorizationType": "password",
  "shareRecipientAuthorization": "aSecretPassword!"
}

Properties

Name	Type	Required	Restrictions	Description
shareRecipientAuthorizationType	ShareRecipientAuthorizationType	false	none	The type of authorization used to authorize the recipient of the share.
shareRecipientAuthorization	string	false	none	The authorization used to authorize the recipient of the share.

ShareRecipientAuthorizationType

"password"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	password
anonymous	none
anonymous	passwordHash_Base64_SHA256

ShareRecipientIdentifierType

"email"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	email
anonymous	none

ShareState

"OK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	OK
anonymous	Pending
anonymous	Cancelled
anonymous	Broken
anonymous	CreationFailure
anonymous	ResourceDepleted
anonymous	Creating
anonymous	Expired

SharedResource

{
  "shareID": "string",
  "createdAt": "2011-12-03T10:15:30+01:00",
  "validFrom": "2011-12-03T10:15:30+01:00",
  "validUntil": "2011-12-07T10:15:30+01:00",
  "userId": {
    "name": "bob@example.com"
  },
  "state": "OK",
  "shareAuthorizationType": "none",
  "shareProtectionType": "PASSWORD",
  "sharedResource": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "message": "string",
  "maxNumOfOperations": -1,
  "errorMessage": "string"
}

Detailed Information about the share.

Properties

Name	Type	Required	Restrictions	Description
shareID	string	false	none	The (non secret) identity of the share that is used to manage the share.
createdAt	string	false	none	The timestamp when the share was created (ISO-8601 extended offset date-time format).
validFrom	string	false	none	The timestamp when the share will start to be valid (ISO-8601 extended offset date-time format).
validUntil	string	false	none	The validity of the share from the ‘validFrom’ timestamp to this ‘validUntil’ expressed as a ISO-8601 extended offset date-time format.
userId	UserId	false	none	The creator of the share.
state	ShareState	false	none	The state of the share.
shareAuthorizationType	ShareAuthorizationType	false	none	The required authorization to access as a recipient of this share.
shareProtectionType	ProtectionType	false	none	The share protection type if the share is protected.
sharedResource	SPScope	false	none	The shared resource.
message	string	false	none	A message to be displayed to the recipient of the share, describing the content of the share.
maxNumOfOperations	integer(int32)	false	none	The max num of operations allowed for this share (e.g. download/upload not view fileinfo). If set to negative no restrictions exists.
errorMessage	string	false	none	An error message explaining why the share has failed (if it has failed).

SharedResourceCreateResult

{
  "sharekey": "B0A7A4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A77C1",
  "shareid": "A0A1B4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A66C2",
  "shareURI": "https://www.example.org/share/B0A7A4B76E0D8CD17A997D8F151B73E1C262D5B10B98D8FD7D1D4D3AC49A77C1"
}

Properties

Name	Type	Required	Restrictions	Description
sharekey	string	false	none	The (secret) of the shared resource, this secret shall be appended with protocol + host and provided to the recipient of the share
shareid	string	false	none	The (non secret) id of the shared resource, that can be used to manage the share
shareURI	string	false	none	The URi of the share, to be provided to the recipient

SharedResourceIndata

{
  "name": "string",
  "validUntil": "2011-12-05T10:15:30+01:00",
  "validFrom": "2011-12-03T10:15:30+01:00",
  "scope": {
    "clients": [
      "SynkzoneWeb"
    ],
    "name": "scopename",
    "description": "access a file",
    "permissions": {
      "Zone=a96ddc43-e050-47f3-97eb-d80dfcd8deea": {
        "all": true
      },
      "ZoneFile=B79542DAB6D64F1682F530F9C9AA7E36EC167F9C0000018016E7963799053C10": {
        "list": true,
        "get": true,
        "access": true,
        "modify": true
      }
    }
  },
  "messageText": "Hi, here is the latest account statement.",
  "shareURI": "https://www.example.com:123/sharedlinks/{sharekey}/download",
  "password": [
    "a",
    "b",
    "c",
    "1"
  ],
  "shareAuthorization": {
    "myType": "userAndPassword",
    "userAndAuth": [
      {
        "shareRecipient": {
          "displayName": "christer",
          "userName": "christer@example.com",
          "internalIdentifier": "abc123",
          "shareInformationRecipientIdentifierType": "none",
          "shareInformationRecipientIdentifier": ""
        },
        "shareRecipientAuthorization": {
          "shareRecipientAuthorizationType": "password",
          "shareRecipientAuthorization": "aSecretPassword!"
        }
      }
    ]
  },
  "shareProtection": {
    "type": "PASSWORD",
    "password": [
      "p",
      "a",
      "s",
      "s",
      "w",
      "o",
      "r",
      "d"
    ]
  },
  "maxNumberOfOperations": -1
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The (non secret) name of the share that is used for display and manage purposes. If not provided by the user it will be generated from the ID.
validUntil	string	false	none	The validity of the share in ISO-8601 extended offset date-time formator or a String representation of UNIX epoch timestamp in milliseconds.
validFrom	string	false	none	The (optional) timestamp (either empty, a ISO-8601 extended offset date-time format or a String representation of UNIX epoch timestamp in milliseconds) from when the link shall start to be valid. If empty this means valid from now. if the user provides a timestamp within one minute of now or less (e.g. expired), it will be adjusted to now + 1 minute.
scope	SPScope	false	none	The shared resource expressed as a scope.
messageText	string	false	none	A message text attached to the share that is displayed for the recipient.
shareURI	string	false	none	The endpoint URI with a template for sharekey used by the recipient to retrieve the resource. Expressed as scheme ‘:’ [‘//’ authority] path.
password	[string]	false	none	The password of the creator (if a logon policy that requires password is used)
shareAuthorization	ShareAuthorization	false	none	none
shareProtection	ShareProtection	false	none	An optional Protection for the share. Currently NONE (no authorization) and PASSWORD types are supported. A Password is considered valid if it consists of at least 4 characters and it does not start or end with Character.isWhiteSpace, which covers spaces, tabs, line breaks and other Unicode whitespace characters.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	PasswordShareProtection	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	ShareProtection	false	none	Base class for protected shares. Specific protections will need to subclass ShareProtectionDto, e.g. PasswordShareProtectionDto

continued

Name	Type	Required	Restrictions	Description
maxNumberOfOperations	integer(int32)	false	none	An optional max number of operations, e.g. downloads of files. When exceeded the share is cancelled. Set to -1 for unlimited usage.

SignOn

"Local"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Local
anonymous	ClientVerification
anonymous	PasswordAlways
anonymous	OTP
anonymous	TwoFA
anonymous	IDP

SignOnURI

{
  "uri": "string"
}

The URI for making an OAuth 2.x or OIDC authorization request to the IDP configured for the specified organization. The response from this URI (received at the specified redirectURI) can later be used as authorization token provided by the user controller in a call to the signOn method.

Properties

Name	Type	Required	Restrictions	Description
uri	string	false	none	none

State

"PASSWORDPENDING"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	PASSWORDPENDING
anonymous	VERIFICATIONCODEPENDING

TenantData

{
  "id": "string",
  "information": {
    "name": "string",
    "description": "string",
    "sspData": {
      "property1": "string",
      "property2": "string"
    }
  },
  "createdAt": "2023-12-03T10:15:30+01:00",
  "createdBy": {
    "name": "bob@example.com"
  },
  "removedAt": "2023-12-03T10:15:30+01:00",
  "removedBy": {
    "name": "bob@example.com"
  },
  "managerId": {
    "name": "bob@example.com"
  }
}

Complete data about a Tenant for use by SSP administrators. Includes a unique TenantId identifier for referring to the tenant unambiguously, which never can be changed. All user modifiable information about the Tenant is collected in the TenantInformation field.

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Unique tenant identifier that is assigned when the Tenant is created. Can be used in a number of platform operations to refer to the Tenant.
information	TenantInformation	false	none	Mutable information about the Tenant.
createdAt	string	false	none	Time stamp (as a ISO-8601 extended offset date-time format) when the Tenant was first created.
createdBy	UserId	false	none	Identity of the user that created the Tenant.
removedAt	string	false	none	Time stamp when the Tenant was removed (as a ISO-8601 extended offset date-time format). If it has not been removed, this field will be zero or negative.
removedBy	UserId	false	none	Identity of the user that removed the user. Only valid if the user has actually been removed as indicated by the removedAt field.
managerId	UserId	false	none	Identity of the user account created to be the tenant manager.

TenantInformation

{
  "name": "string",
  "description": "string",
  "sspData": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name of the tenant as used when displaying it or when referring to it through a UI. Should be unique within an SSP to avoid confusion.
description	string	false	none	Optional short free text description of a tenant, to be displayed for anyone who needs to get a bit more information about the purpose or background of a Tenant. Note that more formal, labeled information shall be included in the information field.
sspData	object	false	none	SSP (Synkzone Service Provider) information about a tenant, for use only by SSP administrators. Can contain any number of labeled fields with information defined by an SSP. May typically include fields for customer identity, contract number, customer contact information, etc.
» additionalProperties	string	false	none	none

TenantInformationIn

{
  "tenantInformation": {
    "name": "string",
    "description": "string",
    "sspData": {
      "property1": "string",
      "property2": "string"
    }
  },
  "managerId": {
    "name": "bob@example.com"
  },
  "userPersonalData": {
    "realName": "Bob Johnson",
    "emailAddresses": "bob@goodtools.com",
    "preferredLanguageCode": "en"
  }
}

Properties

Name	Type	Required	Restrictions	Description
tenantInformation	TenantInformation	false	none	General information about the tenant, such as name, description, and customer data. This can be updated at any time.
managerId	UserId	true	none	The preferred manager account id according to any standard applied by the SSP. The actual account id may be adjusted to make it unique if it already has been used. (Currently a new user account is created)
userPersonalData	UserPersonalData	true	none	Required information about the manager account such as email address etc. Requires at least an e-mail address.

TimeStamp

{
  "timestamp": "2023-12-03T10:15:30+01:00"
}

Properties

Name	Type	Required	Restrictions	Description
timestamp	string	false	none	A timestamp, expressed as ISO-8601 extended offset date-time format

TokenAndExpiry

{
  "token": "string",
  "expiresAt": "2023-12-03T10:15:30+01:00",
  "id": "string",
  "expiry": "string"
}

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	The secret token. This is a secret and shall be treated as such.
expiresAt	string	false	none	The timestamp when the token will expire, expressed as ISO-8601 extended offset date-time format
id	UUID	false	none	The Identity of the token, can be used to manage the token but not use it
expiry	string	false	none	none

TokenInformation

{
  "tokenId": "string",
  "tokenName": "string",
  "clientIdentifier": "string",
  "created": "2011-12-03T10:15:30+01:00",
  "scope": {
    "name": "string",
    "description": "string",
    "clients": [
      "Test"
    ],
    "permissions": {
      "property1": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      },
      "property2": {
        "all": true,
        "create": true,
        "list": true,
        "get": true,
        "access": true,
        "modify": true,
        "delete": true
      }
    },
    "limitations": {
      "property1": null,
      "property2": null
    },
    "extensions": {
      "property1": null,
      "property2": null
    }
  },
  "validUntil": "2011-12-03T10:15:30+01:00",
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
tokenId	UUID	false	none	The Identity of the token, can be used to manage the token but not use it
tokenName	string	false	none	The human readable name/description of the token
clientIdentifier	string	false	none	An optional clientIdentifier if a client is a used for this token
created	string	false	none	The timestamp of when the token was created (ISO-8601 extended offset date-time format).
scope	SPScope	false	none	The scope of the token
validUntil	string	false	none	The timestamp in in (ISO-8601 extended offset date-time format) when the token will expire.
id	UUID	false	none	none

TokenRequest

{
  "grant_type": "password",
  "username": "alice@example.com",
  "password": "SuperSecretPassword123!"
}

Input model for exchanging user credentials for an access token using the Resource Owner Password Credentials (ROPC) grant type. The grant type must always be ‘password’.

Properties

Name	Type	Required	Restrictions	Description
grant_type	string	true	none	The OAuth2 grant type. Must be exactly ‘password’ for ROPC exchanges.
username	string	true	none	The user’s unique login name, email, or identifier depending on your authentication system (can be empty for some authorizations). This value is used to verify credentials and to include in the access token as the principal (subject).
password	string	true	none	The user’s password associated with the username. It should be transmitted over HTTPS only.

Type

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	SwedishPersonalNumber

UUID

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(uuid)	false	none	none

UsageReport

{
  "user": "chris@example.com",
  "ipHeader": "212.193.12.123",
  "fileId": "B79542DAB6D64F1682F530F9C9AA7E36EC167F9C0000018016E7963799053C10",
  "versionTimeStamp": "2023-04-11T18:06:12.056+02:00",
  "type": "download",
  "timeStamp": "2011-12-03T10:15:30+01:00"
}

Information about a share access, e.g. a download or upload.

Properties

Name	Type	Required	Restrictions	Description
user	string	false	none	The user, empty is anonymous.
ipHeader	string	false	none	The ip address of the (recipient) user.
fileId	string	false	none	The fileid of the up or downloaded file.
versionTimeStamp	string	false	none	The version timestamp (created) of the fileid, expressed as ISO-8601 extended offset date-time format.
type	string	false	none	The type of resource utilization, e.g. download or upload.
timeStamp	string	false	none	The timestamp of the resource usage, in ISO-8601 extended offset date-time format.

UserActions

{
  "changePersonalData": true,
  "changeAuthorizationData": true,
  "changeExternalId": true,
  "allowedAuthorizations": [
    "None"
  ],
  "assignNewCredentials": true,
  "canDeactivate": true,
  "canReactivate": true,
  "canRemove": true,
  "canSetPersonalIdentity": true,
  "canGetPersonalIdentity": true,
  "canRemovePersonalIdentity": true,
  "canHide": true,
  "canUnhide": true,
  "canGetSignOnHistory": true
}

Describes what actions that are allowed

Properties

Name	Type	Required	Restrictions	Description
changePersonalData	boolean	false	none	True if the current user is allowed to change personal data (email addresses, real name, etc.) for this user.
changeAuthorizationData	boolean	false	none	True if the current user is allowed to change the authorization level for this user.
changeExternalId	boolean	false	none	True if the current user is allowed to change the external id for this user.
allowedAuthorizations	[UserAuthorizationData]	false	none	The authorization levels that the current user can assign to this user. The levels are sorted in ascending order.
assignNewCredentials	boolean	false	none	True if the current user is allowed to assign new sign-on credentials (password, OTP account, …) for this user.
canDeactivate	boolean	false	none	True if the current user can deactivate this user.
canReactivate	boolean	false	none	True if the current user can reactivate this user.
canRemove	boolean	false	none	True if the current user can permanently remove this user account.
canSetPersonalIdentity	boolean	false	none	True if the current user can set a personal identity for this user account.
canGetPersonalIdentity	boolean	false	none	True if the current user can get a personal identity for this user account.
canRemovePersonalIdentity	boolean	false	none	True if the current user can remove a personal identity for this user account.
canHide	boolean	false	none	True if the current user can make this user account hidden.
canUnhide	boolean	false	none	True if the current user can make this user account not hidden.
canGetSignOnHistory	boolean	false	none	True if the current user can get the sign on history for this user account.

UserAndAuth

{
  "shareRecipient": "userAndPassword",
  "shareRecipientAuthorization": {
    "shareRecipientAuthorizationType": "password",
    "shareRecipientAuthorization": "aSecretPassword!"
  }
}

Properties

Name	Type	Required	Restrictions	Description
shareRecipient	ShareRecipient	true	none	The type of authorization required.
shareRecipientAuthorization	ShareRecipientAuthorization	false	none	none

UserAuthorizationData

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Removed
anonymous	Inactive
anonymous	Group
anonymous	Visitor
anonymous	Guest
anonymous	External
anonymous	Internal
anonymous	Manager
anonymous	Administrator
anonymous	Recovery
anonymous	Main

UserData

{
  "realName": "string",
  "emailAddresses": "string",
  "preferredLanguageCode": "string",
  "active": true,
  "hidden": false,
  "externalUserName": "string",
  "userAuthorizationData": "None"
}

Properties

Name	Type	Required	Restrictions	Description
realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be first name and/or last name, or other descriptive name.
emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.
active	boolean	false	none	If false the user is deactivated and not allowed to logon
hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
externalUserName	string	false	none	An external userName or Id that is used by an external Identity Management System such as an Identity management system.
userAuthorizationData	UserAuthorizationData	false	none	The user authorization level.

UserId

{
  "name": "bob@example.com"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The userId often expressed as a @ where could be ‘firstname.lastname’ or any unique name. is the ‘organization name’ where the user exists.

UserId1

{
  "id": "string",
  "name": "string",
  "group": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
group	boolean	false	none	none

UserInformationData

{
  "userId": "string",
  "displayName": "string",
  "active": true,
  "removed": true,
  "externalUserName": "string",
  "personalData": {
    "realName": "Bob Johnson",
    "emailAddresses": "bob@goodtools.com",
    "preferredLanguageCode": "en"
  },
  "passwordChangeRequired": false,
  "authorization": "None",
  "hiddenPassword": true,
  "password": [
    "string"
  ],
  "actions": {
    "changePersonalData": true,
    "changeAuthorizationData": true,
    "changeExternalId": true,
    "allowedAuthorizations": [
      "None"
    ],
    "assignNewCredentials": true,
    "canDeactivate": true,
    "canReactivate": true,
    "canRemove": true,
    "canSetPersonalIdentity": true,
    "canGetPersonalIdentity": true,
    "canRemovePersonalIdentity": true,
    "canHide": true,
    "canUnhide": true,
    "canGetSignOnHistory": true
  },
  "verifiedName": "string",
  "hidden": true,
  "createableUserAccountTypes": [
    "Guest",
    "External",
    "Internal",
    "Manager"
  ],
  "createableZoneTypes": [
    {
      "description": "Personal",
      "id": "032bfbea-9046-440e-ba5a-5be22a2f6ebc"
    },
    {
      "description": "Normal",
      "id": "b06543cc-b076-4032-8da1-3b363ee4d103"
    },
    {
      "description": "Read protected",
      "id": "56e69c5c-0579-41a8-8597-0d2946908a98"
    }
  ],
  "groups": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2011-12-03T10:15:30+01:00",
  "createdBy": "string",
  "removedAt": "2011-12-03T10:15:30+01:00",
  "removedBy": "string",
  "assignedCredentialsAt": "2011-12-03T10:15:30+01:00",
  "assignedCredentialsBy": "string",
  "tenantId": "string",
  "tenantName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The UserIdentity consists of either name or name@organization, where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: Only consist of Letter and Digits, dot, underscore and minus. Does not start with ‘group.’, dot or underscore. Does not end with dot or underscore.
displayName	string	false	none	A (calculated) name to use for display purposes.
active	boolean	false	none	If the user account is active or not.
removed	boolean	false	none	If the user account is removed or not.
externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence. Can be used to connect to create a unique reference in an IDP.
passwordChangeRequired	boolean	false	none	If true user should be required to change password
authorization	UserAuthorizationData	false	none	Authorization contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator. See schema UserAuthorizationData
hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
password	[string]	false	none	The password generated at account creation. Note: Normally not available since it will be delivered to the the new user directly. However if the user has an empty e-mail address or the organization has no connected SMTP service, the password will be provided here.
actions	UserActions	false	none	A list of actions that the user can do.
verifiedName	string	false	none	A real name as provided by a PersonalIdentification service.
hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.
createableUserAccountTypes	[UserAuthorizationData]	false	none	A list of UserAuthorizationData for all types of users that this user is allowed to create. An empty list means that the user is not authorized to create any user accounts at all.
createableZoneTypes	[ZoneType]	false	none	A list of ZoneTypeData for all types of zones that this user is allowed to create. An empty list means that the user is not authorized to create any zones at all. Note that regarding personal zones, further restrictions may apply depending on how many personal zones that the user already has created, but these are not taken into account here.
groups	object	false	none	(Deprecated: Will be removed or empty) A list of groups the user is a member of.
» additionalProperties	string(uuid)	false	none	none
createdAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format).
createdBy	string	false	none	A userID of the user that created this account
removedAt	string	false	none	Timestamp indicating the creation time of the user (expressed in ISO8601 extended offset date-time format). Field can be empty if user is not removed.
removedBy	string	false	none	A userID of the user that removed this account
assignedCredentialsAt	string	false	none	Timestamp indicating the time when user credentials were lastly assigned for this user (expressed in ISO8601 extended offset date-time format).
assignedCredentialsBy	string	false	none	A userID of the user that lastly assigned credentials for this account
tenantId	string	false	none	The tenantId if the user belongs to a tenant
tenantName	string	false	none	The tenantName if the user belongs to a tenant

UserInformationInData

{
  "userId": "bob@goodtools.com",
  "externalUserName": "635",
  "personalData": {
    "realName": "Bob Johnson",
    "emailAddresses": "bob@goodtools.com",
    "preferredLanguageCode": "en"
  },
  "authorization": "None",
  "hiddenPassword": false,
  "hidden": false
}

Information needed to create a User

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The UserIdentity consists of either ‘name’ or ‘name@organization’ (or ‘name@world/organization’ for organizations in a separate Synkzone world), where organization is this specific organization only. The UserIdentity has the same form as an email address but does not need to be a valid e-mail address. The UserIdentity: May only consist of Letter and Digits, dot, underscore and minus. May not start with ‘group.’, dot or underscore. May not end with dot or underscore.
externalUserName	string	false	none	An optional external reference/ID/name that can be used to identify the user.
personalData	UserPersonalData	false	none	The UserPersonalData, such as e-mail, realName and language preferrence.
authorization	UserAuthorizationData	false	none	UserAuthorizationData contains information about the general authorization level for a user account, such as whether the user is external, internal, administrator, or even the main administrator.
hiddenPassword	boolean	false	none	If true, the user password is ‘hidden’ and the user is using other means to sign on.
hidden	boolean	false	none	True if user is hidden. Hidden users are normally invisible in zones and coworker listings. Hidden users are only visible for administrators. Only external users or ‘lower’ user types can be hidden.

UserPersonalData

{
  "realName": "Bob Johnson",
  "emailAddresses": "bob@goodtools.com",
  "preferredLanguageCode": "en"
}

Properties

Name	Type	Required	Restrictions	Description
realName	string	false	none	Real name of a user. Can be any string, but is typically expected to be a first name and/or last name, or other descriptive name.
emailAddresses	string	false	none	Zero or more comma separated email addresses owned by the user. Typically used to send information or notifications to the user, such as account information.
preferredLanguageCode	string	false	none	Language code for the user’s preferred language. If left empty, ‘en’ will be assumed.

Version

{
  "kerdUtil": "string",
  "synkerStorage": "string",
  "SynkerFiles": "string",
  "SynkerClient": "string",
  "SynkerDesktop": "string",
  "SynkerServer": "string",
  "SynkerOrg": "string",
  "SynkerWorld": "string",
  "SynkerWeb": "string",
  "SynkerRemote": "string",
  "SynkerRemoteStorage": "string",
  "SynkzonePlatform": "string",
  "SynkerSSI": "string",
  "SynkerSSIDesktop": "string",
  "synkerFiles": "string",
  "synkerClient": "string",
  "synkerDesktop": "string",
  "synkerServer": "string",
  "synkerOrg": "string",
  "synkerWorld": "string",
  "synkerWeb": "string",
  "synkerRemote": "string",
  "synkerRemoteStorage": "string",
  "synkzonePlatform": "string",
  "synkerSSI": "string",
  "synkerSSIDesktop": "string"
}

All defined versions in this build.

Properties

Name	Type	Required	Restrictions	Description
kerdUtil	string	false	none	none
synkerStorage	string	false	none	none
SynkerFiles	string	false	none	none
SynkerClient	string	false	none	none
SynkerDesktop	string	false	none	none
SynkerServer	string	false	none	none
SynkerOrg	string	false	none	none
SynkerWorld	string	false	none	none
SynkerWeb	string	false	none	none
SynkerRemote	string	false	none	none
SynkerRemoteStorage	string	false	none	none
SynkzonePlatform	string	false	none	none
SynkerSSI	string	false	none	none
SynkerSSIDesktop	string	false	none	none
synkerFiles	string	false	none	none
synkerClient	string	false	none	none
synkerDesktop	string	false	none	none
synkerServer	string	false	none	none
synkerOrg	string	false	none	none
synkerWorld	string	false	none	none
synkerWeb	string	false	none	none
synkerRemote	string	false	none	none
synkerRemoteStorage	string	false	none	none
synkzonePlatform	string	false	none	none
synkerSSI	string	false	none	none
synkerSSIDesktop	string	false	none	none

ZoneAccessMembership

{
  "zoneId": "string",
  "zoneName": "Economy Reports",
  "zoneDescription": "Financial reports for 2021",
  "myAccessLevelData": "None",
  "userAccessLevelData": "None"
}

Properties

Name	Type	Required	Restrictions	Description
zoneId	UUID	true	none	The zone ID.
zoneName	string	true	none	The name of the zone.
zoneDescription	string	false	none	A Human Readable description of the zone.
myAccessLevelData	AccessLevelData	false	none	My access level in the zone.
userAccessLevelData	AccessLevelData	false	none	The access level for the user in the zone.

ZoneActions

{
  "assignAccessRights": true,
  "leave": true,
  "changeSynchronizingClientEnabled": true,
  "changeSynkzoneWebEnabled": true,
  "changeSynkzoneAPIEnabled": true,
  "changeExternalSharingEnabled": true,
  "changeZoneType": true,
  "assignableZoneTypes": [
    {
      "id": "string",
      "description": "string",
      "category": "Personal",
      "defaultSynchronizationMode": "Inactive",
      "allowedSynchronizationModes": [
        "Inactive"
      ]
    }
  ]
}

Class used to to describe what actions a user is allowed to do.

Properties

Name	Type	Required	Restrictions	Description
assignAccessRights	boolean	false	none	The current user can assign or remove access rights for coworkers (but not self)
leave	boolean	false	none	The current user can leave the zone
changeSynchronizingClientEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on synchronizing clients
changeSynkzoneWebEnabled	boolean	false	none	The current user can change whether the zone shall be accessible on web clients
changeSynkzoneAPIEnabled	boolean	false	none	The current user can change whether the zone shall be accessible over the SSI API
changeExternalSharingEnabled	boolean	false	none	The current user can change whether it is allowed to create shared links to the contents of this zone
changeZoneType	boolean	false	none	The current user can change the zone type
assignableZoneTypes	[ZoneType]	false	none	The zone types that may be assigned to this zone

ZoneData

{
  "id": "string",
  "name": "economy2023",
  "description": "All files related to Economy year 2023. Ask Belinda for further information.",
  "type": "56e69c5c-0579-41a8-8597-0d2946908a9",
  "createdAt": "2011-12-03T10:15:30+01:00",
  "createdBy": "bob@example.com",
  "rootId": "7F137E441CD9452F86FCED97EA13BD04982A0206000001861747FF5713E9A24B",
  "currentSize": 0,
  "typeName": "Normal",
  "webAccessible": true,
  "synkerAccessible": true,
  "ssiAccessible": true,
  "allowExternalSharing": true,
  "useECM": true,
  "ecmData": {
    "parameter": "string",
    "status": "string",
    "error": "string"
  },
  "localSynchronizationStatus": "Unknown",
  "localSize": 0,
  "numberOfUsers": 0,
  "zoneActions": {
    "assignAccessRights": true,
    "leave": true,
    "changeSynchronizingClientEnabled": true,
    "changeSynkzoneWebEnabled": true,
    "changeSynkzoneAPIEnabled": true,
    "changeExternalSharingEnabled": true,
    "changeZoneType": true,
    "assignableZoneTypes": [
      {
        "id": "string",
        "description": "string",
        "category": "Personal",
        "defaultSynchronizationMode": "Inactive",
        "allowedSynchronizationModes": [
          "Inactive"
        ]
      }
    ]
  },
  "zoneTypeData": {
    "id": "string",
    "description": "string",
    "category": "Personal",
    "defaultSynchronizationMode": "Inactive",
    "allowedSynchronizationModes": [
      "Inactive"
    ]
  },
  "currentAccess": {
    "memberId": "bob@example.com",
    "accessLevel": "None",
    "displayName": "string",
    "authorization": "None",
    "memberType": "User"
  }
}

Information regarding a specific zone.

Properties

Name	Type	Required	Restrictions	Description
id	UUID	false	none	The zoneId. Unique zone identifier
name	string	false	none	The (human readable) name of the zone
description	string	false	none	Arbitrary description of the zone, such as its purpose etc.
type	UUID	false	none	Zone type specification, which determines a number of zone properties.
createdAt	string	false	none	When, in (ISO-8601 extended offset date-time format), the zone was created.
createdBy	string	false	none	Name of the user that created the zone.
rootId	string	false	none	Zone file identifier for the zone’s root folder. Use this root to list the files and folders that belongs to the zone root.
currentSize	integer(int64)	false	none	(Desktop clients only) The current total size of the zone’s file contents in bytes. (Note for WEB/API, the current size may be presented as 0 for folders).
typeName	string	false	none	Zone type name. For convenience in some use cases (such as UI) instead of having to look it up separately from the type id. Should whenever possible and applicable be translated to the current preferred language.
webAccessible	boolean	false	none	Whether this zone shall be accessible over the web.
synkerAccessible	boolean	false	none	Whether this zone shall be accessible over the API.
ssiAccessible	boolean	false	none	Whether this zone shall be accessible from Synker (desktop clients).
allowExternalSharing	boolean	false	none	Whether sharing of web links to contents in this zone is allowed.
useECM	boolean	false	none	Whether this zone requires use of ECM (External Crypto Module) for access.
ecmData	ECMData	false	none	If ECM (External Crypto Module) is used, the parameters and status for the ECM.
localSynchronizationStatus	ZoneSynchronizationStatus	false	none	(Desktop clients only) The current local synchronization status of the zone. When accessed through a non synchronizing environment (WEBB/API) ‘Preparing’ is expected. For Desktop/synchronizing the following states exists:Unknown, Preparing, Quarantine, Paused, Restoring, Unmapped, MappingError, WriteProtected, InsufficientFileSystem, NoDiskSpace, ClockError, ECMError, Offline, Synchronizing, Synchronized, Inactive
localSize	integer(int64)	false	none	(Desktop clients only) The current size this zone takes up on local disk, i.e. how much of the zone contents that are locally available. When accessed through a non synchronizing environment (WEBB/API) ‘0’ is expected.
numberOfUsers	integer(int32)	false	none	The current number of members in this zone, i.e. users (and groups) that have some level of access rights.
zoneActions	ZoneActions	false	none	The actions that the current user can perform on the zone.
zoneTypeData	ZoneType	false	none	Information about the zonetype such as its id, description and type.
currentAccess	ZoneMember	false	none	The access rights the current user has to this zone. This specifies both the access level and whether the access is direct by assignment to the user’s own account, or indirect via a group membership.

ZoneFileActions

{
  "open": true,
  "openConflict": true,
  "showConflict": true,
  "removeConflict": true,
  "useConflicting": true,
  "browse": true,
  "copyPath": true,
  "lock": true,
  "unlock": true,
  "writeProtect": true,
  "writeEnable": true,
  "readProtect": true,
  "readEnable": true,
  "exclude": true,
  "include": true,
  "restore": true,
  "download": true,
  "upload": true,
  "archive": true,
  "cut": true,
  "copy": true,
  "paste": true,
  "newFolder": true,
  "rename": true,
  "delete": true,
  "permanentDelete": true,
  "webLink": true,
  "showLog": true,
  "downloadAuthenticationTimeout": 0,
  "newFile": true,
  "update": true
}

Describes what actions that are allowed on this particular ZoneFile

Properties

Name	Type	Required	Restrictions	Description
open	boolean	false	none	If true the file may be opened
openConflict	boolean	false	none	If true the corresponding conflict file may be opened
showConflict	boolean	false	none	If true the show the corresponding conflict file
removeConflict	boolean	false	none	If true the corresponding conflict file may be removed
useConflicting	boolean	false	none	If true the corresponding conflict file may replace the original file
browse	boolean	false	none	If true the ZoneFile is a directory that can be browsed
copyPath	boolean	false	none	If true the path may be copied to clipboard
lock	boolean	false	none	If true the file may locked (Synkzone distributed lock)
unlock	boolean	false	none	If true the file may unlocked (Synkzone distributed lock)
writeProtect	boolean	false	none	If true, a write protect is possible to set
writeEnable	boolean	false	none	If true, write protect is possible to remove
readProtect	boolean	false	none	If true, Synkzone read protect is possible to set
readEnable	boolean	false	none	If true, Synkzone read protect is possible to remove
exclude	boolean	false	none	If true, the file can be excluded from file synchronization
include	boolean	false	none	If true, the file can be included in file synchronization
restore	boolean	false	none	If true, the file may be restored
download	boolean	false	none	If true, the file may be downloaded
upload	boolean	false	none	If true, a file may be uploaded/added to this folder
archive	boolean	false	none	If true, the file may be archived
cut	boolean	false	none	If true, the file may be cut into clipboard
copy	boolean	false	none	If true, the file may be copied into clipboard
paste	boolean	false	none	If true, the clipboard content can be pasted here
newFolder	boolean	false	none	If true, a new folder can be created here
rename	boolean	false	none	If true, the file can be renamed
delete	boolean	false	none	If true, the file can be deleted
permanentDelete	boolean	false	none	If true, the file can be permanently deleted
webLink	boolean	false	none	If true, the file can be shared through a weblink
showLog	boolean	false	none	If true, the zonelog entries for this file can be displayed
downloadAuthenticationTimeout	integer(int64)	false	none	How long time in milliseconds until authentication is required in order to download this file.
newFile	boolean	false	none	If true, a new file can be created in this folder
update	boolean	false	none	If true, a request can be made to upload a new version of this file

ZoneFileAttributes

{
  "writeProtected": false,
  "readProtected": false,
  "executable": false,
  "hidden": false,
  "synchronize": true
}

Properties

Name	Type	Required	Restrictions	Description
writeProtected	boolean	false	none	true if zoneFile is write protected
readProtected	boolean	false	none	true if zoneFile is read protected
executable	boolean	false	none	true if zoneFile is executable
hidden	boolean	false	none	true if zoneFile is write hidden
synchronize	boolean	false	none	true if zoneFile is set to synchronize

ZoneFileData

{
  "zoneId": "1054b216-e4eb-42d8-8f7c-cb303e3ef600",
  "id": "8A42975022B04A0AA8CCE3E5D906179813DDC384000001892770C00585200392",
  "name": "hello.txt",
  "properName": "hello",
  "displayName": "hello.txt",
  "type": "TXT",
  "parentId": "C4C4A5F15C22438BBA13B76569A5161E4032CCED00000189177087D72E8756C6",
  "folder": true,
  "deleted": true,
  "size": 0,
  "lastModified": "2011-12-03T10:15:30+01:00",
  "lastModifiedBy": "bob@example.com",
  "attributes": {
    "writeProtected": false,
    "readProtected": false,
    "executable": false,
    "hidden": false,
    "synchronize": true
  },
  "lockedBy": "string",
  "synchronizationStatus": "Unknown",
  "availableActions": {
    "open": true,
    "openConflict": true,
    "showConflict": true,
    "removeConflict": true,
    "useConflicting": true,
    "browse": true,
    "copyPath": true,
    "lock": true,
    "unlock": true,
    "writeProtect": true,
    "writeEnable": true,
    "readProtect": true,
    "readEnable": true,
    "exclude": true,
    "include": true,
    "restore": true,
    "download": true,
    "upload": true,
    "archive": true,
    "cut": true,
    "copy": true,
    "paste": true,
    "newFolder": true,
    "rename": true,
    "delete": true,
    "permanentDelete": true,
    "webLink": true,
    "showLog": true,
    "downloadAuthenticationTimeout": 0,
    "newFile": true,
    "update": true
  },
  "zoneFileDownloadStatus": {
    "percentDownloaded": 0,
    "averageDownloadSpeed": 0,
    "estimatedRemainingDownloadTime": 0
  },
  "lastChanged": "2011-12-03T10:15:30+01:00",
  "firstChanged": "2011-12-03T10:15:30+01:00",
  "metadataMap": "2011-12-03T10:15:30+01:00"
}

Data related to a file or a folder.

Properties

Name	Type	Required	Restrictions	Description
zoneId	UUID	false	none	The zoneId of the zone
id	string	false	none	The zoneFileId of a file
name	string	false	none	Actual name of the file as used to identify it in the file system
properName	string	false	none	The file’s name without suffix
displayName	string	false	none	The preferred name to use when displaying or referring to the file in a UI. This can be either the full, actual name, the proper name, or some other name derived from the actual name, depending on current preferences.
type	string	false	none	A string describing the file’s type. If no other specific information is available, this may just be the file name suffix.
parentId	string	false	none	The zoneFileId of the parent
folder	boolean	false	none	True if folder and not a file
deleted	boolean	false	none	True if deleted
size	integer(int64)	false	none	The size of the file
lastModified	string	false	none	The lastModified timestamp of the file as a ISO-8601 extended offset date-time format
lastModifiedBy	string	false	none	The userId of the user that last modified the file
attributes	ZoneFileAttributes	false	none	The zoneFileAttribute data
lockedBy	string	false	none	The userId of the user who locked the file, if locked
synchronizationStatus	ZoneFileSynchronizationStatus	false	none	The file synchronization status
availableActions	ZoneFileActions	false	none	The available actions on a ZoneFile
zoneFileDownloadStatus	ZoneFileDownloadStatus	false	none	Download status if the file being downloaded, else null.
lastChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was last changed, this can be used for effective zone log search queries.
firstChanged	string	false	none	The global timestamp (expressed in ISO8601 extended offset date-time format) when the file was first changed, this can be used for effective zone log search queries.
metadataMap	object	false	none	A map of IDs and metadata types
» additionalProperties	string	false	none	none

ZoneFileDownloadStatus

{
  "percentDownloaded": 0,
  "averageDownloadSpeed": 0,
  "estimatedRemainingDownloadTime": 0
}

Properties

Name	Type	Required	Restrictions	Description
percentDownloaded	integer(int32)	false	none	How much of the file that has been downloaded as percent of the full size.
averageDownloadSpeed	integer(int64)	false	none	The average speed measured in B/s that the file has been downloaded with so far…
estimatedRemainingDownloadTime	integer(int64)	false	none	An estimate of the time in seconds remaining until the download is complete…

ZoneFileListOrdering

"AscendingName"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	AscendingName
anonymous	DescendingName
anonymous	AscendingSuffix
anonymous	DescendingSuffix
anonymous	AscendingSize
anonymous	DescendingSize
anonymous	AscendingModification
anonymous	DescendingModification
anonymous	AscendingChange
anonymous	DescendingChange

ZoneFileMetadata

{
  "id": "example-id",
  "type": "example-type",
  "content": "my-json-metadata"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The metadata ID
type	string	false	none	The type of metadata stored
content	string	false	none	The metadata content represented as a string

ZoneFilePathElement

{
  "elementId": "343ED3B2FF464125A50CFA886D2C5E70D4D50CC8000001781675FD8FF0240573",
  "elementName": "folder22"
}

Properties

Name	Type	Required	Restrictions	Description
elementId	string	false	none	The zoneFileId of the element
elementName	string	false	none	The elementName

ZoneFileSynchronizationStatus

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	NotSynchronizing
anonymous	NotAvailable
anonymous	Archived
anonymous	PendingDownload
anonymous	Downloading
anonymous	Available
anonymous	PendingUpload
anonymous	Scanning
anonymous	Uploading

ZoneFileVersion

{
  "index": 0,
  "size": 0,
  "created": "2011-12-03T10:15:30+01:00",
  "createdBy": "string",
  "removed": true,
  "stored": true
}

Properties

Name	Type	Required	Restrictions	Description
index	integer(int32)	false	none	The index of a list of versions
size	integer(int64)	false	none	The file size of this version
created	string	false	none	The timestamp of the file version creation (ISO-8601 extended offset date-time format).
createdBy	string	false	none	The userId of the file version creator
removed	boolean	false	none	True if version is removed
stored	boolean	false	none	True if version is stored

ZoneLogEntry

{
  "zoneId": "string",
  "timestamp": "string",
  "creator": "string",
  "type": "string",
  "subEntry": true,
  "message": "string",
  "fileId": "string",
  "filePath": "string",
  "userId": "string",
  "accessLevel": "string",
  "objectName": "string",
  "objectTime": "string",
  "zoneTypeName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
zoneId	string	false	none	The zoneId
timestamp	string	false	none	Get the time in ISO8601 when the log entry was made. The timestamp is always unique for the ZoneLogEntry and can be used as id.
creator	string	false	none	Get the id of the user that made or caused this entry.
type	string	false	none	Get the main type of entry.
subEntry	boolean	false	none	Check if this entry is not a main entry, but rather is related to a previous or following event in a way that may make it less relevant to view.
message	string	false	none	The message of the entry
fileId	string	false	none	A ZoneFileId if such exists
filePath	string	false	none	Get any file path associated with this entry.
userId	string	false	none	Get the id of any user/group associated with this entry (other than the creator), e.g. a user being given a new access level.
accessLevel	string	false	none	Get any access level associated with this log entry.
objectName	string	false	none	Get any name or description associated with the object that this entry is about, e.g. a zone or user name, or a sharing URL.
objectTime	string	false	none	Get any extra time specification associate with the object that this entry is about, e.g. a creation or last modified time for a file version. Expressed as ISO8601.
zoneTypeName	string	false	none	ZoneTypeName is, where applicable, the name of the type of zone for a newly created zone or that an existing zone has been changed to.

ZoneMember

{
  "memberId": "bob@example.com",
  "accessLevel": "None",
  "displayName": "string",
  "authorization": "None",
  "memberType": "User"
}

Properties

Name	Type	Required	Restrictions	Description
memberId	string	true	none	The memberId, a userId or a groupId.
accessLevel	AccessLevelData	false	none	The AccessLevelData for the member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.
displayName	string	false	none	(Only output. Ignore for create/update operations). The displayName for the member
authorization	UserAuthorizationData	false	none	(Only output. Ignore for create/update operations). The UserAuthorizationData for the member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
memberType	MemberType	false	none	(Only output. Ignore for create/update operations). The member type, whether this member is a user or a group.

ZoneSynchronizationMode

"Inactive"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Inactive
anonymous	Paused
anonymous	Protected
anonymous	Passive
anonymous	Active
anonymous	All

ZoneSynchronizationStatus

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	Preparing
anonymous	Quarantine
anonymous	Paused
anonymous	Restoring
anonymous	Unmapped
anonymous	MappingError
anonymous	WriteProtected
anonymous	InsufficientFileSystem
anonymous	NoDiskSpace
anonymous	ClockError
anonymous	ECMError
anonymous	Offline
anonymous	Synchronizing
anonymous	Synchronized
anonymous	Inactive

ZoneType

{
  "id": "string",
  "description": "string",
  "category": "Personal",
  "defaultSynchronizationMode": "Inactive",
  "allowedSynchronizationModes": [
    "Inactive"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	UUID	false	none	The zoneTypeId
description	string	false	none	A human readable description of the zoneType
category	ZoneTypeCategory	false	none	The zone type expressed as an enum.
defaultSynchronizationMode	ZoneSynchronizationMode	false	none	For Synchroning clients, the default synchronization mode.
allowedSynchronizationModes	[ZoneSynchronizationMode]	false	none	For Synchroning clients, the allowed synchronization modes.

ZoneTypeCategory

"Personal"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Personal
anonymous	Normal
anonymous	ReadProtected

ZoneUser

{
  "userId": "string",
  "accessLevelData": "None"
}

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The userId
accessLevelData	AccessLevelData	false	none	The AccessLevelData for the userId in a zone

ZoneUserData

{
  "userId": "bob@example.com",
  "displayName": "string",
  "authorization": "None",
  "accessLevel": "None"
}

This class is replaced by ZoneMember

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The userId.
displayName	string	false	none	(Ignore for create/update operations). The displayName for the user/member
authorization	UserAuthorizationData	false	none	(Ignore for create/update operations). The UserAuthorizationData for the user/member. It contains information about the general authorization level for a user account, such as whether the user is external, and administrator, or even the main administrator.
accessLevel	AccessLevelData	false	none	The AccessLevelData for the user/member, such as None, Access, Add, Update, Modify, Manage for Zones and Access or Modify for Groups. Note: Please note that if a member of a zone holds membership through a group and is additionally assigned a specific access level as an individual user, the access level assigned to the user will take precedence over the access level granted through the group.