Benutzer:Hartwigr: Unterschied zwischen den Versionen

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche
Keine Bearbeitungszusammenfassung
Markierung: Zurückgesetzt
(Hartwigr änderte das Inhaltsmodell der Seite Benutzer:Hartwigr von „Wikitext“ nach „JSON“)
Markierungen: Änderung des Inhaltsmodells Zurückgesetzt
Zeile 1: Zeile 1:
{
{
    "openapi": "3.0.3",
    "info": {
        "title": "Cryptshare REST API",
        "description": "REST API of Cryptshare Server, currently focussed on Cryptshare for OWA.",
        "version": "1.7"
    },
    "servers": [
        {
            "url": "{protocol}://{host}/api",
            "description": "The Cryptshare Server to use the API with.",
            "variables": {
                "protocol": {
                    "description": "The protocol of target Cryptshare Server.",
                    "default": "https"
                },
                "host": {
                    "description": "The host of the target Cryptshare Server.",
                    "default": "localhost"
                }
            }
        }
    ],
    "tags": [
        {
            "name": "client",
            "description": "Operations to initiate a REST API consumer client."
        },
        {
            "name": "cors",
            "description": "Operation to retrieve CORS status for the requesting origin."
        },
        {
            "name": "download",
            "description": "Operations to download transfer information and files."
        },
        {
            "name": "imprint",
            "description": "Operations to get the product imprint."
        },
        {
            "name": "language-packs",
            "description": "Operations to retrieve language pack resources and information."
        },
        {
            "name": "logging",
            "description": "Operations to retrieve logging settings and perform remote logging."
        },
        {
            "name": "password",
            "description": "Operations for generating, validating passwords and viewing the password requirements"
        },
        {
            "name": "terms-of-use",
            "description": "Operations to retrieve resources and information regarding the terms of use."
        },
        {
            "name": "transfer-policy",
            "description": "Operations to retrieve information about the transfer policy."
        },
        {
            "name": "transfer-session",
            "description": "Operations to create and access new transfers."
        },
        {
            "name": "verification",
            "description": "Operations to access user verification."
        }
    ],
    "paths": {
        "/clients": {
            "get": {
                "tags": [
                    "client"
                ],
                "summary": "Requests a generated client id that can be used for all operations that require a client id.",
                "operationId": "getVerificationStatusUsingGET_3",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/ClientId"
                    },
                    {
                        "$ref": "#/components/parameters/MajorVersion"
                    },
                    {
                        "$ref": "#/components/parameters/MinimumMinorApiVersion"
                    },
                    {
                        "$ref": "#/components/parameters/ProductKey"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ClientId",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "400": {
                        "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ProductKey).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "403": {
                        "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "404": {
                        "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "500": {
                        "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": false
                                },
                                "exampleSetFlag": false
                            }
                        }
                    }
                }
            }
        },
        "/products/{product-key}/cors": {
            "get": {
                "tags": [
                    "cors"
                ],
                "summary": "Returns the CORS status for the given product and requesting origin.",
                "operationId": "getCorsStatusUsingGET_1",
                "parameters": [
                    {
                        "name": "product-key",
                        "in": "path",
                        "description": "The product key of the product whose CORS status is requested.",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "name": "Origin",
                        "in": "header",
                        "description": "The origin header consists of scheme, host and port",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "$ref": "#/components/parameters/ClientId"
                    },
                    {
                        "$ref": "#/components/parameters/MajorVersion"
                    },
                    {
                        "$ref": "#/components/parameters/MinimumMinorApiVersion"
                    },
                    {
                        "$ref": "#/components/parameters/ProductKey"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ResponseOfCorsStatus",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "400": {
                        "description": "A required query parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "403": {
                        "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "404": {
                        "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "500": {
                        "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": false
                                },
                                "exampleSetFlag": false
                            }
                        }
                    }
                }
            }
        },
        "/transfers/{transfer-id}": {
            "get": {
                "tags": [
                    "download"
                ],
                "summary": "Returns the transfer information.",
                "operationId": "getTransferInformationUsingGET_7",
                "parameters": [
                    {
                        "name": "transfer-id",
                        "in": "path",
                        "description": "The transfer ID of the transfer whose information is requested.",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "name": "password",
                        "in": "query",
                        "description": "The URL encoded password for the transfer (can be specified by query parameter or header).",
                        "required": false,
                        "style": "form",
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "name": "X-CS-Password",
                        "in": "header",
                        "description": "The URL encoded password for the transfer (can be specified by query parameter or header).",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "$ref": "#/components/parameters/ClientId"
                    },
                    {
                        "$ref": "#/components/parameters/MajorVersion"
                    },
                    {
                        "$ref": "#/components/parameters/MinimumMinorApiVersion"
                    },
                    {
                        "$ref": "#/components/parameters/ProductKey"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ResponseOfTransferInfo",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "400": {
                        "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. transferId).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "401": {
                        "description": "Unauthorized.\n * 3003 - Wrong transfer password",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "403": {
                        "description": "The client is not allowed to perform the requested operation.\n * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "404": {
                        "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "410": {
                        "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "501": {
                        "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "500": {
                        "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": false
                                },
                                "exampleSetFlag": false
                            }
                        }
                    }
                }
            }
        },
        "/transfers/{transfer-id}/checksums": {
            "get": {
                "tags": [
                    "download"
                ],
                "summary": "Returns a CSV file download stream including the checksums of all files in the transfer. \nTo customize the locale of the checksums, the 'Accept-Language' header can be used.",
                "operationId": "downloadChecksumsUsingGET_4",
                "parameters": [
                    {
                        "name": "transfer-id",
                        "in": "path",
                        "description": "The transfer ID of the transfer whose information is requested.",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "name": "password",
                        "in": "query",
                        "description": "The URL encoded password for the transfer (can be specified by query parameter or header).",
                        "required": false,
                        "style": "form",
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "name": "X-CS-Password",
                        "in": "header",
                        "description": "The URL encoded password for the transfer (can be specified by query parameter or header).",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "exampleSetFlag": true
                        }
                    },
                    {
                        "$ref": "#/components/parameters/ClientId"
                    },
                    {
                        "$ref": "#/components/parameters/MajorVersion"
                    },
                    {
                        "$ref": "#/components/parameters/MinimumMinorApiVersion"
                    },
                    {
                        "$ref": "#/components/parameters/ProductKey"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "text/csv": {
                                "schema": {
                                    "$ref": "#/components/schemas/StreamingResponseBody",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "400": {
                        "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. transferId).",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "401": {
                        "description": "Unauthorized.\n * 3003 - Wrong transfer password",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "403": {
                        "description": "The client is not allowed to perform the requested operation.\n * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
                        }
                    },
                    "404": {
                        "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error",
                                    "exampleSetFlag": true
                                },
                                "exampleSetFlag": false
                            }
 

Version vom 16. Mai 2023, 07:58 Uhr

openapi"3.0.3"
info
title"Cryptshare REST API"
description"REST API of Cryptshare Server, currently focussed on Cryptshare for OWA."
version"1.7"
servers
url"{protocol}://{host}/api"
description"The Cryptshare Server to use the API with."
variables
protocol
description"The protocol of target Cryptshare Server."
default"https"
host
description"The host of the target Cryptshare Server."
default"localhost"
tags
name"client"
description"Operations to initiate a REST API consumer client."
name"cors"
description"Operation to retrieve CORS status for the requesting origin."
name"download"
description"Operations to download transfer information and files."
name"imprint"
description"Operations to get the product imprint."
name"language-packs"
description"Operations to retrieve language pack resources and information."
name"logging"
description"Operations to retrieve logging settings and perform remote logging."
name"password"
description"Operations for generating, validating passwords and viewing the password requirements"
name"terms-of-use"
description"Operations to retrieve resources and information regarding the terms of use."
name"transfer-policy"
description"Operations to retrieve information about the transfer policy."
name"transfer-session"
description"Operations to create and access new transfers."
name"verification"
description"Operations to access user verification."
paths
/clients
get
tags
"client"
summary"Requests a generated client id that can be used for all operations that require a client id."
operationId"getVerificationStatusUsingGET_3"
parameters
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ClientId"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ProductKey). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/cors
get
tags
"cors"
summary"Returns the CORS status for the given product and requesting origin."
operationId"getCorsStatusUsingGET_1"
parameters
name"product-key"
in"path"
description"The product key of the product whose CORS status is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"Origin"
in"header"
description"The origin header consists of scheme, host and port"
requiredtrue
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfCorsStatus"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required query parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}
get
tags
"download"
summary"Returns the transfer information."
operationId"getTransferInformationUsingGET_7"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfTransferInfo"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}/checksums
get
tags
"download"
summary"Returns a CSV file download stream including the checksums of all files in the transfer. To customize the locale of the checksums, the 'Accept-Language' header can be used."
operationId"downloadChecksumsUsingGET_4"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
text/csv
schema
$ref"#/components/schemas/StreamingResponseBody"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}/eml
get
tags
"download"
summary"Returns an EML file download stream including the confidential message with attachments embedded."
operationId"downloadEmlUsingGET_7"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose files are requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
name"threshold"
in"query"
description"The threshold in megabytes for embedding attachments to the EML body."
requiredfalse
style"form"
schema
type"integer"
format"int32"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/octet-stream
schema
$ref"#/components/schemas/StreamingResponseBody"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}/files
get
tags
"download"
summary"Returns the transfer files information. Note that the `href` of the returned transfer files additionally includes the general parameters that are usually sent via headers for convenience. If the password was specified, it is also included in the `href`."
operationId"getTransferFilesInformationUsingGET_7"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfListOfTransferFile"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}/files/{file-id}
get
tags
"download"
summary"Returns a file download stream for a transfer file."
operationId"downloadSingleFileUsingGET_4"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose file is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
name"file-id"
in"path"
description"The file id of the file to download, retrieved from the files endpoint."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/octet-stream
schema
$ref"#/components/schemas/StreamingResponseBody"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId, fileId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId or fileId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/transfers/{transfer-id}/zip
get
tags
"download"
summary"Returns a ZIP file download stream including all transfer files of this transfer. To customize the locale of the checksums, the 'Accept-Language' header can be used."
operationId"downloadZipUsingGET_4"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose files are requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
style"form"
schema
type"string"
exampleSetFlagtrue
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
exampleSetFlagtrue
name"include-checksum-file"
in"query"
description"If the checksum file from the checksum endpoint should be included in the ZIP file."
requiredfalse
style"form"
schema
type"boolean"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/zip
schema
$ref"#/components/schemas/StreamingResponseBody"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/legal/imprint
get
tags
"imprint"
summary"Returns the imprint content."
operationId"getImprintUsingGET_8"
parameters
name"product-key"
in"path"
description"The product key of the product whose imprint is requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfImprint"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/language-packs
get
tags
"language-packs"
summary"Returns a list of installed language packs for the specified product."
operationId"getAllLanguagePacksUsingGET"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"major-version"
in"query"
description"The major-version of language packs. If specified, the returned list only contains language packs matching that version."
requiredfalse
style"form"
schema
type"integer"
format"int32"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK"
content
application/json
schema
$ref"#/components/schemas/ResponseOfListOfLanguagePack"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). "
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/language-packs/{lp-id}
get
tags
"language-packs"
summary"Returns a list of installed language packs for the specified product."
operationId"getLanguagePackUsingGET_7"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"lp-id"
in"path"
description"The ID of the specific language pack."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK"
content
application/json
schema
$ref"#/components/schemas/ResponseOfLanguagePack"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid request parameter (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/language-packs/{lp-id}/*/**
get
tags
"language-packs"
summary"Returns a resource (stream) of certain resource of a language pack."
operationId"getLanguagePackFileUsingGET_6"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"lp-id"
in"path"
description"The ID of the specific language pack."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK. Content type may be different, depending on the requested resource."
content
*/*
schema
type"string"
format"byte"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/logging
get
tags
"logging"
summary"Returns the logging settings for the given product and client."
operationId"getLoggingSettingsUsingGET_6"
parameters
name"product-key"
in"path"
description"The product key of the product the logging settings are requested for."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfLoggingSettings"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/password
get
tags
"password-gernerate"
summary"Generate a valid password."
operationId"generatePasswordUsingGET_4"
parameters
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfPassword-Wrapper"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
post
tags
"password-validate"
summary"Validates a given password against the current password requirements."
operationId"validatePasswordUsingPOST_7"
parameters
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/Password-Wrapper"
exampleSetFlagtrue
exampleSetFlagfalse
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfPasswordValidationResult"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/password/requirements
get
tags
"password-requirements"
summary"Requests the currently active password requirements."
operationId"getPasswordRequirementsUsingGET"
parameters
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfListOfPasswordValidationRule"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/logs
post
tags
"logging"
summary"Sends a single log message to the Cryptshare Server for the purpose of being logged remotely."
operationId"addLogEventUsingPOST_6"
parameters
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
type"array"
exampleSetFlagtrue
items
$ref"#/components/schemas/LogEntry"
exampleSetFlagfalse
exampleSetFlagfalse
responses
200
description"OK"
201
description"The resource was created successfully"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3004 - Remote logging not permitted."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/products/{product-key}/legal/terms-of-use
get
tags
"terms-of-use"
summary"Returns information about the provided terms of use."
operationId"getUsageTermsUsingGET_6"
parameters
name"product-key"
in"path"
description"The product key of the product whose terms of use are requested."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfTermsOfUseInfo"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/users/{email-address}/transfer-policy
post
tags
"transfer-policy"
summary"Requests the policy for the user as sender and the given recipients."
operationId"requestPolicyUsingPOST_5"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferPolicyRequest"
exampleSetFlagtrue
exampleSetFlagfalse
responses
200
description"Success."
content
application/json
schema
$ref"#/components/schemas/ResponseOfTransferPolicyResult"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, email-address)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3010 - Email address and (possibly) IP address of the sender is rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
/users/{email-address}/transfer-sessions
post
tags
"transfer-session"
summary"Creates a new transfer session. Initial values for the sender and recipient languages can be set by using the 'Accept-Language' header."
operationId"createSessionUsingPOST_3"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferSessionCreationOptions"
exampleSetFlagtrue
exampleSetFlagfalse
responses
201
description"Created the transfer session. The 'Location' header will contain the URL of the created session."
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3010 - Sender rejected by policy. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
/users/{email-address}/transfer-sessions/{tracking-id}
get
tags
"transfer-session"
summary"Requests an existing transfer session. Note that all properties will be present."
operationId"getSessionUsingGET_7"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfTransferSession"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
patch
tags
"transfer-session"
summary"Edits an existing transfer session."
operationId"editSessionUsingPATCH_1"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferSessionPatchable"
exampleSetFlagtrue
exampleSetFlagfalse
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOfTransferSession"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. "
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
409
description"Validation of parameters failed. * 2001 - Some given values cannot be applied due to transfer rule restrictions."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
/users/{email-address}/transfer-sessions/{tracking-id}/files
post
tags
"transfer-session"
summary"Creates a new transfer file."
operationId"createFileUsingPOST"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferFileCreationOptionsReq"
exampleSetFlagtrue
exampleSetFlagfalse
responses
201
description"Created the transfer file. The 'Location' header will contain the URL of the created file."
content
application/json
schema
$ref"#/components/schemas/TransferFileCreationOptionsRes"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}/content
put
tags
"transfer-session"
summary"Writes raw binary data to a transfer file. If data was already written to this file, it is replaced. Clients may want to stream the data if fitting."
operationId"putFileUsingPUT_7"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"file-id"
in"path"
description"The file ID to write data for."
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"Ok."
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
security
verification
Leeres Array
/users/{email-address}/verification
get
tags
"verification"
summary"Checks if an active verification for the provided mail exists, and what verification methods are available."
operationId"getVerificationStatusUsingGET_16"
parameters
name"email-address"
in"path"
description"email-address"
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
name"X-CS-VerificationToken"
in"header"
description"The verification token to check."
requiredfalse
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/VerificationStatus"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3002 - Invalid verification data."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
/users/{email-address}/verification/code/email
post
tags
"verification"
summary"Requests a sender verification verification code to be sent via mail. Note that repeated access in quick succession may cause rate limiting. Note that previously created verification codes may be invalidated. To customize the locale of the mail, the 'Accept-Language' header can be used."
operationId"generateVerificationCodeUsingPOST_6"
parameters
name"email-address"
in"path"
description"email-address"
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
responses
200
description"OK."
content
application/json
schema
type"object"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
429
description"Too Many Requests. * 2007 - Request rejected because there are too many requests at the same time"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
/users/{email-address}/verification/token
post
tags
"verification"
summary"Creates a verification token. Note that repeated access in quick succession may cause rate limiting."
operationId"createVerificationTokenUsingPOST"
parameters
name"email-address"
in"path"
description"email-address"
requiredtrue
style"simple"
schema
type"string"
exampleSetFlagtrue
$ref"#/components/parameters/ClientId"
$ref"#/components/parameters/MajorVersion"
$ref"#/components/parameters/MinimumMinorApiVersion"
$ref"#/components/parameters/ProductKey"
requestBody
content
application/json
schema
$ref"#/components/schemas/RequestVerificationBody"
exampleSetFlagtrue
exampleSetFlagfalse
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/VerificationToken"
exampleSetFlagtrue
exampleSetFlagfalse
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3002 - Invalid verification data."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
429
description"Too Many Requests. * 2007 - Request rejected because there are too many requests at the same time"
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagtrue
exampleSetFlagfalse
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
components
schemas
ClientId
title"ClientId"
type"object"
properties
clientId
type"string"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
exampleSetFlagtrue
exampleSetFlagtrue
CorsStatus
title"CorsStatus"
type"object"
properties
active
type"boolean"
description"Specifies whether CORS is active or not for requesting origin"
exampletrue
exampleSetFlagtrue
exampleSetFlagtrue
Details
title"Details"
type"object"
exampleSetFlagtrue
EidSecurityMode
title"EidSecurityMode"
type"object"
properties
config
description"Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID')."
$ref"#/components/schemas/EidSecurityModeConfig"
exampleSetFlagtrue
name
type"string"
description"Name of the security mode."
exampleSetFlagtrue
enum
"EID"
"ONE_TIME_PASSWORD"
"QUICK"
exampleSetFlagtrue
EidSecurityModeConfig
title"EidSecurityModeConfig"
type"object"
exampleSetFlagtrue
Error
title"Error"
type"object"
properties
errorCode
type"integer"
description"Proprietary Cryptshare Server error code."
format"int32"
exampleSetFlagtrue
errorMessage
type"string"
description"Short description of the error code in English."
exampleSetFlagtrue
exampleSetFlagtrue
FailedRecipient
title"FailedRecipient"
type"object"
properties
emailAddress
type"string"
description"The email address of the failed recipient."
example"abc.def@example.com"
exampleSetFlagtrue
reason
type"string"
description"The reason of the denial of the recipient. Currently, only 'POLICY_MISMATCH' is supported."
exampleSetFlagtrue
enum
"POLICY_MISMATCH"
exampleSetFlagtrue
Imprint
title"Imprint"
type"object"
properties
content
type"string"
description"Either an URL pointing to the imprint (type 'link') or the content itself (type 'html')."
example"<h1>Imprint</h1><p>Lorem ipsum...</p>"
exampleSetFlagtrue
type
type"string"
description"Specifies value type of the content property.."
example"html"
exampleSetFlagtrue
enum
"html"
"link"
exampleSetFlagtrue
LanguagePack
title"LanguagePack"
type"object"
properties
displayName
type"string"
description"The display name of the language, in the respective language."
example"English (US)"
exampleSetFlagtrue
href
type"string"
description"The absolute path to the language pack resources."
example"/api/products/client.owa/language-packs/en-US_2"
exampleSetFlagtrue
id
type"string"
description"Id of the language pack, contains locale and major version."
example"en-US_2"
exampleSetFlagtrue
lastChangeTimestamp
type"string"
description"The date and time of the last update of the language pack, or null, if it was never updated. Format: ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
locale
type"string"
description"IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en-US"
exampleSetFlagtrue
version
type"string"
description"The version of the language pack, consisting of major and minor version."
example"2.1"
exampleSetFlagtrue
exampleSetFlagtrue
LogEntry
title"LogEntry"
type"object"
properties
level
type"string"
description"Assumes a severity ordering as specified by RFC 5424."
exampleSetFlagtrue
enum
"debug"
"error"
"info"
"trace"
"warn"
message
type"string"
description"The log message."
exampleSetFlagtrue
timestamp
type"string"
description"ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
exampleSetFlagtrue
LoggingSettings
title"LoggingSettings"
type"object"
properties
level
type"string"
description"Assumes a severity ordering as specified by RFC 5424."
exampleSetFlagtrue
enum
"debug"
"error"
"info"
"trace"
"warn"
remoteLoggingEnabled
type"boolean"
description"Specifies whether the requesting client should send its log entries to the Cryptshare Server."
exampletrue
exampleSetFlagtrue
exampleSetFlagtrue
OneTimePasswordSecurityMode
title"OneTimePasswordSecurityMode"
type"object"
properties
config
description"Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID')."
$ref"#/components/schemas/OneTimePasswordSecurityModeConfig"
exampleSetFlagtrue
name
type"string"
description"Name of the security mode."
exampleSetFlagtrue
enum
"EID"
"ONE_TIME_PASSWORD"
"QUICK"
exampleSetFlagtrue
OneTimePasswordSecurityModeConfig
title"OneTimePasswordSecurityModeConfig"
type"object"
properties
allowedPasswordModes
type"array"
description"Password modes allowed for one time passwords."
example"["NONE", "MANUAL", "GENERATED"]"
exampleSetFlagtrue
items
type"string"
exampleSetFlagfalse
enum
"GENERATED"
"MANUAL"
"NONE"
exampleSetFlagtrue
Password-Wrapper
title"Password-Wrapper"
required
"password"
type"object"
properties
password
type"string"
exampleSetFlagtrue
exampleSetFlagtrue
PasswordValidationResult
title"PasswordValidationResult"
type"object"
properties
rulesNotFulfilled
type"array"
description"List of rules that are not fulfilled by the given password"
exampleSetFlagtrue
items
$ref"#/components/schemas/PasswordValidationRule"
exampleSetFlagfalse
valid
type"boolean"
description"Whether the given password is valid."
examplefalse
exampleSetFlagtrue
description"Results of the validation of a given password"
exampleSetFlagtrue
PasswordValidationRule
title"PasswordValidationRule"
type"object"
properties
details
description"Details of the rule."
$ref"#/components/schemas/Details"
exampleSetFlagtrue
name
type"string"
description"Name of the rule."
exampleSetFlagtrue
description"Represents a rule a password has to fulfill to be valid"
exampleSetFlagtrue
QuickSecurityMode
title"QuickSecurityMode"
type"object"
properties
config
description"Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID')."
$ref"#/components/schemas/QuickSecurityModeConfig"
exampleSetFlagtrue
name
type"string"
description"Name of the security mode."
exampleSetFlagtrue
enum
"EID"
"ONE_TIME_PASSWORD"
"QUICK"
exampleSetFlagtrue
QuickSecurityModeConfig
title"QuickSecurityModeConfig"
type"object"
properties
allowedPasswordModes
type"array"
description"Password modes allowed for invitational (initial) QUICK transfers."
example"["NONE", "MANUAL", "GENERATED"]"
exampleSetFlagtrue
items
type"string"
exampleSetFlagfalse
enum
"GENERATED"
"MANUAL"
"NONE"
defaultIfEstablished
type"boolean"
description"Specifies whether the client should set QUICK as default security mode if the sender has an already established QUICK connection with all recipients."
examplefalse
exampleSetFlagtrue
exampleSetFlagtrue
Recipient
title"Recipient"
type"object"
properties
mail
type"string"
description"The recipient email address."
exampleSetFlagtrue
exampleSetFlagtrue
Recipients
title"Recipients"
type"object"
properties
bcc
uniqueItemstrue
type"array"
description"The 'BCC' recipients."
exampleSetFlagtrue
items
$ref"#/components/schemas/Recipient"
exampleSetFlagfalse
cc
uniqueItemstrue
type"array"
description"The 'CC' recipients."
exampleSetFlagtrue
items
$ref"#/components/schemas/Recipient"
exampleSetFlagfalse
to
uniqueItemstrue
type"array"
description"The 'To' recipients."
exampleSetFlagtrue
items
$ref"#/components/schemas/Recipient"
exampleSetFlagfalse
description"The recipients of the transfer grouped by to, cc and bcc."
exampleSetFlagtrue
RequestVerificationBody
title"RequestVerificationBody"
required
"verificationCode"
type"object"
properties
verificationCode
type"string"
description"Code that confirms this verification. Must be present unless requesting a verification using client-id."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfCorsStatus
title"ResponseOfCorsStatus"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/CorsStatus"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfImprint
title"ResponseOfImprint"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/Imprint"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfLanguagePack
title"ResponseOfLanguagePack"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/LanguagePack"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfListOfLanguagePack
title"ResponseOfListOfLanguagePack"
type"object"
properties
data
type"array"
description"Main data of the response."
exampleSetFlagtrue
items
$ref"#/components/schemas/LanguagePack"
exampleSetFlagfalse
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfListOfPasswordValidationRule
title"ResponseOfListOfPasswordValidationRule"
type"object"
properties
data
type"array"
description"Main data of the response."
exampleSetFlagtrue
items
$ref"#/components/schemas/PasswordValidationRule"
exampleSetFlagfalse
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfListOfTransferFile
title"ResponseOfListOfTransferFile"
type"object"
properties
data
type"array"
description"Main data of the response."
exampleSetFlagtrue
items
$ref"#/components/schemas/TransferFile"
exampleSetFlagfalse
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfLoggingSettings
title"ResponseOfLoggingSettings"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/LoggingSettings"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfPassword-Wrapper
title"ResponseOfPassword-Wrapper"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/Password-Wrapper"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfPasswordValidationResult
title"ResponseOfPasswordValidationResult"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/PasswordValidationResult"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfTermsOfUseInfo
title"ResponseOfTermsOfUseInfo"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/TermsOfUseInfo"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfTransferInfo
title"ResponseOfTransferInfo"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/TransferInfo"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfTransferPolicyResult
title"ResponseOfTransferPolicyResult"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/TransferPolicyResult"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
ResponseOfTransferSession
title"ResponseOfTransferSession"
type"object"
properties
data
description"Main data of the response."
$ref"#/components/schemas/TransferSession"
exampleSetFlagtrue
meta
type"object"
description"Additional response metadata."
exampleSetFlagtrue
exampleSetFlagtrue
Sender
title"Sender"
type"object"
properties
name
type"string"
description"The sender name."
exampleSetFlagtrue
phone
type"string"
description"The sender phone."
exampleSetFlagtrue
description"The sender of the transfer (without email)."
exampleSetFlagtrue
StreamingResponseBody
title"StreamingResponseBody"
type"object"
exampleSetFlagtrue
TermsOfUse
title"TermsOfUse"
type"object"
properties
content
type"string"
description"Either an URL pointing to the terms of use (type 'link') or the content of the terms of use itself (type 'html')"
example"<p>The terms of use!</p>"
exampleSetFlagtrue
locale
type"string"
description"IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en-US"
exampleSetFlagtrue
title
type"string"
description"Title of the terms of use, in the respective language."
example"Cryptshare at ACME Inc., Terms of Use"
exampleSetFlagtrue
type
type"string"
description"Specifies the value type of the content property."
example"html"
exampleSetFlagtrue
enum
"html"
"link"
exampleSetFlagtrue
TermsOfUseInfo
title"TermsOfUseInfo"
type"object"
properties
active
type"boolean"
description"Specifies whether terms of use are active or not. Active terms of use need to be accepted by users before first usage of the product or whenever terms are changed."
exampletrue
exampleSetFlagtrue
lastChangeTimestamp
type"string"
description"The date and time of the last change of the terms of use, or null, if the terms of use have never been changed. Format: ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
terms
type"array"
description"The terms of use in specific languages."
exampleSetFlagtrue
items
$ref"#/components/schemas/TermsOfUse"
exampleSetFlagfalse
exampleSetFlagtrue
TransferFile
title"TransferFile"
type"object"
properties
checksum
type"string"
description"The checksum of the file."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
exampleSetFlagtrue
fileName
type"string"
description"The name of the file."
example"Invoice.pdf"
exampleSetFlagtrue
href
type"string"
description"The absolute path to the transfer file."
exampleSetFlagtrue
id
type"string"
description"The ID of this file."
example"a58dFp1Tr7"
exampleSetFlagtrue
size
type"integer"
description"The file size in bytes."
format"int64"
example13987
exampleSetFlagtrue
exampleSetFlagtrue
TransferFileCreationOptionsReq
title"TransferFileCreationOptionsReq"
required
"fileName"
"size"
type"object"
properties
checksum
type"string"
description"The checksum of the file. This may be provided to check the file integrity during processing. For the used algorithm, see the corresponding transfer session."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
exampleSetFlagtrue
fileName
type"string"
description"The name of the file."
exampleSetFlagtrue
size
type"integer"
description"The file size in bytes. This may be provided to allow the server to give early feedback regarding exceeded size limits."
format"int64"
exampleSetFlagtrue
exampleSetFlagtrue
TransferFileCreationOptionsRes
title"TransferFileCreationOptionsRes"
required
"fileId"
type"object"
properties
fileId
type"string"
description"The ID of the file."
exampleSetFlagtrue
exampleSetFlagtrue
TransferInfo
title"TransferInfo"
type"object"
properties
checksumAlgorithm
type"string"
description"The checksum algorithm used for checksum generation."
example"SHA-256"
exampleSetFlagtrue
totalSize
type"integer"
description"The total file size in bytes."
format"int64"
example13987
exampleSetFlagtrue
exampleSetFlagtrue
TransferNotificationMessage
title"TransferNotificationMessage"
type"object"
properties
body
type"string"
description"The body of the transfer notification. May contain HTML."
exampleSetFlagtrue
subject
type"string"
description"The subject of the transfer notification."
exampleSetFlagtrue
exampleSetFlagtrue
TransferOneTimePasswordSecurityModeConfigReq
title"TransferOneTimePasswordSecurityModeConfigReq"
type"object"
properties
password
type"string"
description"The password for the transfer."
exampleSetFlagtrue
passwordMode
type"string"
description"The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server."
exampleSetFlagtrue
enum
"GENERATED"
"MANUAL"
"NONE"
exampleSetFlagtrue
TransferOneTimePasswordSecurityModeConfigRes
title"TransferOneTimePasswordSecurityModeConfigRes"
type"object"
properties
password
type"string"
description"The password for the transfer."
exampleSetFlagtrue
passwordMode
type"string"
description"The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server."
exampleSetFlagtrue
enum
"GENERATED"
"MANUAL"
"NONE"
exampleSetFlagtrue
TransferOneTimePasswordSecurityModeReq
title"TransferOneTimePasswordSecurityModeReq"
type"object"
properties
config
description"The configuration of the security mode."
$ref"#/components/schemas/TransferOneTimePasswordSecurityModeConfigReq"
exampleSetFlagtrue
name
type"string"
description"The identifier for this security mode."
exampleSetFlagtrue
enum
"ONE_TIME_PASSWORD"
exampleSetFlagtrue
TransferOneTimePasswordSecurityModeRes
title"TransferOneTimePasswordSecurityModeRes"
type"object"
properties
config
description"The configuration of the security mode."
$ref"#/components/schemas/TransferOneTimePasswordSecurityModeConfigRes"
exampleSetFlagtrue
name
type"string"
description"The identifier for this security mode."
exampleSetFlagtrue
enum
"ONE_TIME_PASSWORD"
exampleSetFlagtrue
TransferPolicyRequest
title"TransferPolicyRequest"
required
"recipients"
type"object"
properties
recipients
type"array"
exampleSetFlagtrue
items
type"string"
exampleSetFlagfalse
exampleSetFlagtrue
TransferPolicyResult
title"TransferPolicyResult"
type"object"
properties
allowed
type"boolean"
description"Whether a transfer with the requested sender-recipient combination would be allowed or not. Please note that if the user isn't allowed as sender at all, the request would result in a error response instead."
exampletrue
exampleSetFlagtrue
failedRecipients
uniqueItemstrue
type"array"
description"List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed."
exampleSetFlagtrue
items
$ref"#/components/schemas/FailedRecipient"
exampleSetFlagfalse
settings
description"The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all."
$ref"#/components/schemas/TransferPolicySettings"
exampleSetFlagtrue
exampleSetFlagtrue
TransferPolicySettings
title"TransferPolicySettings"
type"object"
properties
confidentialMessageAllowed
type"boolean"
description"Specifies whether a confidential message can be part of the transfer or not."
examplefalse
exampleSetFlagtrue
confidentialMessageRequired
type"boolean"
description"Specifies whether a confidential message has to be part of the transfer or not."
examplefalse
exampleSetFlagtrue
maxRetentionPeriod
type"integer"
description"Max. number of days the transfer is retrievable, starting at the transfer's provision time."
format"int64"
example30
exampleSetFlagtrue
maxTotalSize
type"integer"
description"Max. total size of all files in bytes."
format"int64"
example2147483648
exampleSetFlagtrue
recipientNotificationEditable
type"boolean"
description"Specifies whether the recipient notification can be edited or not."
examplefalse
exampleSetFlagtrue
securityModes
type"array"
description"List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client."
exampleSetFlagtrue
items
$ref"Error-ModelName{namespace='com.cryptshare.server.api.rest.ui.v1.users.transfers', name='SecurityModeDtoOfSecurityModeConfigDto'}"
exampleSetFlagfalse
sendDownloadNotificationsChangeable
type"boolean"
description"Specifies whether the sendDownloadNotificationsDefault setting is changeable or not."
examplefalse
exampleSetFlagtrue
sendDownloadNotificationsDefault
type"boolean"
description"Default setting for sending download notifications on file retrieval."
examplefalse
exampleSetFlagtrue
showFileNamesChangeable
type"boolean"
description"Specifies whether the showFileNamesDefault setting is changeable or not."
examplefalse
exampleSetFlagtrue
showFileNamesDefault
type"boolean"
description"Default setting for showing file names in notifications and logs."
examplefalse
exampleSetFlagtrue
showZipFileContentDefault
type"boolean"
description"Default setting for showing file names within ZIP files in notifications and logs. This only has an effect if file names are shown in general."
examplefalse
exampleSetFlagtrue
exampleSetFlagtrue
TransferSecurityModeOfobject
title"TransferSecurityModeOfobject"
type"object"
properties
config
type"object"
description"The configuration of the security mode."
exampleSetFlagtrue
name
type"string"
description"The identifier for this security mode."
exampleSetFlagtrue
enum
"ONE_TIME_PASSWORD"
description"Security mode. Possible implementations are: 'TransferOneTimePasswordSecurityMode'"
exampleSetFlagtrue
TransferSession
title"TransferSession"
type"object"
properties
classificationId
type"string"
description"An optional ID for the type of classification used for this transfer."
exampleSetFlagtrue
confidentialMessageFileId
type"string"
description"The file ID of the confidential message. May be null."
exampleSetFlagtrue
expirationDate
type"string"
description"The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
fileChecksumAlgorithm
type"string"
description"The name of the hashing algorithm that will be used for files in this transfer."
example"SHA256"
exampleSetFlagtrue
files
uniqueItemstrue
type"array"
description"The files of this transfer."
exampleSetFlagtrue
items
$ref"#/components/schemas/TransferSessionFile"
exampleSetFlagfalse
notificationMessage
description"The notification mail that will be sent to the recipients."
$ref"#/components/schemas/TransferNotificationMessage"
exampleSetFlagtrue
recipientLanguage
type"string"
description"The recipient language. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
exampleSetFlagtrue
recipients
$ref"#/components/schemas/Recipients"
exampleSetFlagtrue
securityMode
description"The security mode for this transfer."
$ref"#/components/schemas/TransferSecurityModeOfobject"
exampleSetFlagtrue
sendDownloadNotifications
type"boolean"
description"If notification mails should be sent to the sender when a file is downloaded."
examplefalse
exampleSetFlagtrue
sendDownloadSummary
type"boolean"
description"If a summary notification mail should be sent to the sender the transfer expires."
examplefalse
exampleSetFlagtrue
sendRecipientNotification
type"boolean"
description"If notification mails should be sent to the recipients after the transfer is provided."
examplefalse
exampleSetFlagtrue
sendUploadSummary
type"boolean"
description"If a confirmation notification mail should be sent to the sender after the transfer is provided."
examplefalse
exampleSetFlagtrue
sender
$ref"#/components/schemas/Sender"
exampleSetFlagtrue
senderLanguage
type"string"
description"The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
exampleSetFlagtrue
showFileNames
type"boolean"
description"If file names should be shown in notification mails."
examplefalse
exampleSetFlagtrue
showZipFileContent
type"boolean"
description"If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false."
examplefalse
exampleSetFlagtrue
exampleSetFlagtrue
TransferSessionCreationOptions
title"TransferSessionCreationOptions"
type"object"
properties
recipients
$ref"#/components/schemas/Recipients"
exampleSetFlagtrue
sender
$ref"#/components/schemas/Sender"
exampleSetFlagtrue
exampleSetFlagtrue
TransferSessionFile
title"TransferSessionFile"
type"object"
properties
checksum
type"string"
description"The checksum of the file."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
exampleSetFlagtrue
fileName
type"string"
description"The name of the file."
example"Invoice.pdf"
exampleSetFlagtrue
href
type"string"
description"The absolute path to the transfer file."
exampleSetFlagtrue
id
type"string"
description"The ID of this file."
example"a58dFp1Tr7"
exampleSetFlagtrue
size
type"integer"
description"The file size in bytes."
format"int64"
example13987
exampleSetFlagtrue
state
type"string"
description"The state of this file."
exampleSetFlagtrue
enum
"ACTIVE"
"INITIALIZED"
"UPLOADED"
exampleSetFlagtrue
TransferSessionPatchable
title"TransferSessionPatchable"
type"object"
properties
classificationId
type"string"
description"An optional ID for the type of classification used for this transfer."
exampleSetFlagtrue
confidentialMessageFileId
type"string"
description"The file ID of the confidential message. May be null."
exampleSetFlagtrue
expirationDate
type"string"
description"The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
fileChecksumAlgorithm
type"string"
description"The name of the hashing algorithm that will be used for files in this transfer."
example"SHA256"
exampleSetFlagtrue
notificationMessage
description"The notification mail that will be sent to the recipients."
$ref"#/components/schemas/TransferNotificationMessage"
exampleSetFlagtrue
recipientLanguage
type"string"
description"The recipient language. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
exampleSetFlagtrue
securityMode
description"The security mode for this transfer."
$ref"#/components/schemas/TransferSecurityModeOfobject"
exampleSetFlagtrue
sendDownloadNotifications
type"boolean"
description"If notification mails should be sent to the sender when a file is downloaded."
examplefalse
exampleSetFlagtrue
sendDownloadSummary
type"boolean"
description"If a summary notification mail should be sent to the sender the transfer expires."
examplefalse
exampleSetFlagtrue
sendRecipientNotification
type"boolean"
description"If notification mails should be sent to the recipients after the transfer is provided."
examplefalse
exampleSetFlagtrue
sendUploadSummary
type"boolean"
description"If a confirmation notification mail should be sent to the sender after the transfer is provided."
examplefalse
exampleSetFlagtrue
sender
$ref"#/components/schemas/Sender"
exampleSetFlagtrue
senderLanguage
type"string"
description"The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
exampleSetFlagtrue
showFileNames
type"boolean"
description"If file names should be shown in notification mails."
examplefalse
exampleSetFlagtrue
showZipFileContent
type"boolean"
description"If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false."
examplefalse
exampleSetFlagtrue
exampleSetFlagtrue
VerificationStatus
title"VerificationStatus"
type"object"
properties
validUntil
type"string"
description"The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
verificationMethods
uniqueItemstrue
type"array"
description"A list of available verification methods."
exampleSetFlagtrue
items
type"string"
exampleSetFlagfalse
enum
"CLIENT_ID"
"EMAIL"
verified
type"boolean"
description"The state if the client is verified for the specified email address."
exampletrue
exampleSetFlagtrue
exampleSetFlagtrue
VerificationToken
title"VerificationToken"
type"object"
properties
token
type"string"
description"The verification token"
exampleSetFlagtrue
validUntil
type"string"
description"The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
exampleSetFlagtrue
exampleSetFlagtrue
responses
500
description"Server error occurred. * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error)."
content
application/json
schema
$ref"#/components/schemas/Error"
exampleSetFlagfalse
exampleSetFlagfalse
parameters
ClientId
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
exampleSetFlagfalse
MajorVersion
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
format"int32"
example1
exampleSetFlagtrue
MinimumMinorApiVersion
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
format"int32"
example5
exampleSetFlagtrue
ProductKey
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
requiredfalse
schema
type"string"
example"client.Owa"
exampleSetFlagtrue
securitySchemes
verification
type"apiKey"
description"Verification token. Can also be specified by query parameter (verification-token)."
name"X-CS-VerificationToken"
in"header"
Abgerufen von „https://documentation.cryptshare.com/w/index.php?title=Benutzer:Hartwigr&oldid=32912“