diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..3e5b7ef --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,go.sum,*.css,.codespellrc +check-hidden = true +# ignore-regex = +ignore-words-list = transferd diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..c59e047 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/app/python/src/examples/faspex5.py b/app/python/src/examples/faspex5.py index 4a6b700..29ae5c1 100755 --- a/app/python/src/examples/faspex5.py +++ b/app/python/src/examples/faspex5.py @@ -90,7 +90,7 @@ def build_recipient_list(f5_api, emails): # Get access to the Faspex 5 API # - # bearer token is valid for some time and can (should) be re-used, until expired, then refresh it + # bearer token is valid for some time and can (should) be reused, until expired, then refresh it # in this example we generate a new bearer token for each script invocation f5_api = utils.rest.Rest(f'{config.param("faspex5", "url")}{F5_API_PATH_V5}') f5_api.setVerify(config.param('faspex5', 'verify', True)) diff --git a/app/python/src/utils/rest.py b/app/python/src/utils/rest.py index e80fd81..666c99a 100644 --- a/app/python/src/utils/rest.py +++ b/app/python/src/utils/rest.py @@ -60,7 +60,7 @@ def setDefaultScope(self, scope=None): In this example we generate a new bearer token for each script invocation. - But in real code, as the bearer token is valid for some time, it should be re-used, until expired, then refresh it. + But in real code, as the bearer token is valid for some time, it should be reused, until expired, then refresh it. """ self.headers['Authorization'] = self.getBearerTokenAuthorization(scope) diff --git a/openapi/IBM Aspera Faspex API-5.0.json b/openapi/IBM Aspera Faspex API-5.0.json index 5a83916..d9e0cc6 100644 --- a/openapi/IBM Aspera Faspex API-5.0.json +++ b/openapi/IBM Aspera Faspex API-5.0.json @@ -310,7 +310,7 @@ "tags": [ "Authorization" ], - "description": "When you call this endpoint, you are redirected to the Faspex login page to log in as a user. By logging in, you are implicitly authorizing the client to act as that user. Once authenticated, you are redirected to the given `redirect_uri`. Implement a GET endpoint that matches the `redirect_uri` on your application that can recieve and handle the URL-encoded authorization code.", + "description": "When you call this endpoint, you are redirected to the Faspex login page to log in as a user. By logging in, you are implicitly authorizing the client to act as that user. Once authenticated, you are redirected to the given `redirect_uri`. Implement a GET endpoint that matches the `redirect_uri` on your application that can receive and handle the URL-encoded authorization code.", "parameters": [ { "name": "client_id", @@ -571,7 +571,7 @@ "tags": [ "Authorization" ], - "description": "When you call this endpoint and link requires multi factor authentication, you are redirected to enter verification code page or if link does not require multi factor authentication, you are redirected to the given redirect_uri. Implement a GET endpoint that matches the redirect_uri on your application that can recieve and handle the URL-encoded authorization code.", + "description": "When you call this endpoint and link requires multi factor authentication, you are redirected to enter verification code page or if link does not require multi factor authentication, you are redirected to the given redirect_uri. Implement a GET endpoint that matches the redirect_uri on your application that can receive and handle the URL-encoded authorization code.", "security": [ { "PasscodeAuth": [] @@ -5008,7 +5008,7 @@ "schema": { "type": "integer" }, - "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." + "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." } ], "responses": { @@ -5698,7 +5698,7 @@ }, "code": { "type": "string", - "description": "Shorthand description for whether package was succesfully deleted or not." + "description": "Shorthand description for whether package was successfully deleted or not." }, "message": { "type": "string", @@ -6924,7 +6924,7 @@ "schema": { "type": "integer" }, - "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." + "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." }, { "in": "query", @@ -7172,7 +7172,7 @@ "schema": { "type": "integer" }, - "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." + "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." }, { "in": "query", @@ -10149,7 +10149,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The SLO respone target URL." + "description": "The SLO response target URL." }, "cert_multi": { "minLength": 1, @@ -12663,7 +12663,7 @@ "schema": { "type": "integer" }, - "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." + "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000." } ], "responses": { @@ -30338,7 +30338,7 @@ }, "multi_session": { "type": "integer", - "description": "The multi-session threshhold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split." + "description": "The multi-session threshold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split." }, "rate_policy": { "minLength": 1, @@ -53207,7 +53207,7 @@ }, "multi_session": { "type": "integer", - "description": "The multi-session threshhold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split." + "description": "The multi-session threshold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split." }, "paths": { "type": "array", diff --git a/openapi/IBM Aspera Node API-4.4.6.yaml b/openapi/IBM Aspera Node API-4.4.6.yaml index aed2149..819e0ed 100644 --- a/openapi/IBM Aspera Node API-4.4.6.yaml +++ b/openapi/IBM Aspera Node API-4.4.6.yaml @@ -3002,7 +3002,7 @@ components: - aes-256 content_protection_secret: type: string - description: "Provide a server side enryption at rest secret. Files transfered\ + description: "Provide a server side encryption at rest secret. Files transferred\ \ with server side encryption at rest are automatically encrypted on upload\ \ and decrypted on download. This secret can not be changed via PUT. If\ \ you need capabilities to rotate passwords, then consider the BYOK option\ @@ -3010,7 +3010,7 @@ components: \ storage provider." file_checksum_type: type: string - description: "The type of checksum reporting to perform on each file transfered.\ + description: "The type of checksum reporting to perform on each file transferred.\ \ Value is \"none\", \"md5\", \"sha1\", \"sha-256\", \"sha-384\", \"sha-512\"\ . Default is unset, such that the transfer will not report file checksums\ \ unless the remote server is configured to report file checksums." @@ -3120,7 +3120,7 @@ components: - aes-256 file_checksum_type: type: string - description: "The type of checksum reporting to perform on each file transfered.\ + description: "The type of checksum reporting to perform on each file transferred.\ \ Value is \"none\", \"md5\", \"sha1\", \"sha-256\", \"sha-384\", \"sha-512\"\ . Default is unset, such that the transfer will not report file checksums\ \ unless the remote server is configured to report file checksums." diff --git a/openapi/IBM Aspera on Cloud API-0.2.6.json b/openapi/IBM Aspera on Cloud API-0.2.6.json index 05b5914..b469dfb 100644 --- a/openapi/IBM Aspera on Cloud API-0.2.6.json +++ b/openapi/IBM Aspera on Cloud API-0.2.6.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"description":"API for Aspera File Management","version":"0.2.7","title":"Files API","x-ibm-name":"files-api_latest","contact":{"name":"Carole Baden","email":"cbaden@us.ibm.com"}},"servers":[{"url":"https://api.ibmaspera.com/"}],"tags":[{"description":"Use /clients to register your client application with the Files API. You can also modify your client, retrieve a list of all registered clients or a specific client, or delete a specific client. You can configure your client to use browser-based authentication or JSON web token (JWT) authentication. For clients using JWT authentication, this endpoint relates to /client_authorizations.","name":"/clients"},{"description":"When you use the JWT authentication method for your client (see /clients) and enable a whitelist of authorized users or groups, you must configure which users or groups can access the API using your client, and which type of key each user can submit to retrieve an access token–either a user-specific key or a global key. Use the /client_authorizations endpoint to configure the authorized users or groups; use the /users endpoint to configure the user key types; use the /clients endpoint to configure the global key. There are two configuration parameters for users and keys. Users: All users: All users in the AoC organization are eligible to retrieve an access token; Only listed users: Only the users or groups you list are eligible to receive an access token. Keys: User-specific keys: The JWT must be signed with the specified user's own private key; User-specific keys and global key: The JWT can be signed with the specified user's own private key or with the global private key. Note: Any user accessing the AoC API using the JWT method must have their public key listed in their AoC user record. The user can enter their own public key, or the AoC administrator can enter the user's public key in the individual user's record. Important! API clients with a global key can retrieve access tokens for and act as any listed user. Use global keys according to local site security practice.","name":"/client_authorizations"},{"description":"Create a workspace (requires an admin token). The workspace is a distinct context in which workspace members can freely share files and send packages. All workspace users of the same type (for example, members or workspace managers) share collaboration settings for that user type. A workspace is a folder on a specific node; the workspace storage is separate from the storage of other workspaces. The workspace contains member users and groups. A workspace may have a workspace manager, who is also a workspace member, that can perform certain administrative function for that specific workspace. (Configure workspace manager using /workspace_memberships).","name":"/workspaces"},{"description":"Use this endpoint to add existing users as members of a workspace, and to update, retrieve, and delete workspace members. An Aspera on Cloud user can be a direct member of a workspace, or can inherit membership by being a member of a user group that is a member of the workspace. This endpoint allows you to add a user or group as a direct member of a workspace. You can also use this endpoint to grant or revoke workspace manager permission to a member (user or group).","name":"/workspace_memberships"},{"description":"A package is a bundle of files and folders (like a ZIP file or TAR file) specified by an AoC user to send to designated recipients. Packages can be sent to individuals, to groups (including to a workspace), or to shared inboxes. Packages can be sent, received, recalled, archived, deleted. Sending a package can be completed with a user token or with an admin token. The process of sending a package comprises multiple steps. You use the POST, GET, and PUT methods of /packages, along with requests to the Connect API or the Node API. The folder structure of a package on disk is as follows: {id}.asp-package contains metadata and other package-related files and contains contents, which contains the files and folders in the package. Uploads of package contents should go directly into the named, innermost folder. Downloads of the entire package should be of the named, outermost folder (renamed on download to the package name itself). To get package transfers to properly register, they should be tagged as follows: {\"aspera\": {\"files\": {\"package_id\" : the-package-id}}}.","name":"/packages"},{"description":"A user is anybody using this service. Users may be organization administrators, workspace managers, photographers, IT, etc. Users are identified by email address, so 'email' is a required property when creating a new user.","name":"/users"},{"name":"/nodes","description":"The Nodes resource contains the information that a client app can use to communicate directly with an Aspera transfer server (which has files and folders).\n"},{"description":"A shared inbox (formerly called a dropbox) serves three functions. First, it acts as a place where users can submit content. Second, it notifies its members when new content arrives. Finally, it can ask users who submit new content to fill out a form using a metadata schema.\n","name":"/dropboxes"},{"description":"Use this endpoint to add existing members to a dropbox and to update, retrieve, and delete existing dropbox members. An Aspera on Cloud user can be a direct member of a dropbox or they can inherit membership through a user group.\n","name":"/dropbox_memberships"},{"name":"/usage_reports","description":"When enabled, usage reporting collects information about the number of bytes transferred into and out of an organization, on a per-workspace or per-access key basis. A report begins at the start of a month (or when usage reporting is enabled) and ends at the beginning of the next month, when a new report is created. An active report for the current month shows month-to-date usage information, while usage reports for previous months no longer change and show historical data. Due to the way the reporting information is collected, the number of bytes transferred is an approximation and may vary from the actual billed usage if there are transfers that are close to or spanning the changeover between months. NOTE: Usage reports are read-only resources and all attributes are read-only.\n"},{"name":"/organizations","description":"An organization contains all the users, groups, and resources belonging to a real-world organization. Users within an organization can see only the organization they are in. Organization admins can change certain properties of the organization. All other users within the organization have read-only access. Note: /organization is an alias to /organizations/{current user's organization id}.\n"},{"description":"This endpoint is used to manage existing transfer node access keys. Specifically, it streamlines the task of viewing all access keys across all transfer nodes that belong to your organization. Note that this endpoint is not capable of creating or destroying transfer node access keys (that is handled via the Node API). Organization admin or workspace manager permissions are required for any access to this endpoint.\n","name":"/client_access_keys"},{"description":"The /apps/app_memberships endpoint is useful for organization admins that want to enable users to access the Automation or Activity apps. Additionally, this endpoint is useful for admins who want to view all app memberships across their entire organization, or for any other user to view their own app memberships.\n","name":"/apps/app_memberships"}],"paths":{"/apps/app_memberships":{"get":{"parameters":[{"description":"Can be \"activity\" or \"automation\".","in":"query","name":"aspera_app_type","schema":{"type":"string"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"description":"Set to false if you want to filter out inherited memberships.\n","in":"query","name":"inherited","schema":{"type":"boolean"}},{"in":"query","name":"last_login_at","schema":{"format":"date-time","type":"string"}},{"description":"For member_type=user.","in":"query","name":"member.email","schema":{"type":"string"}},{"description":"For member_type=user.","in":"query","name":"member.name","schema":{"type":"string"}},{"description":"Can be \"user\" or \"group\".","in":"query","name":"member_type","schema":{"type":"string"}},{"description":"Searches member.email and member.name.","in":"query","name":"q","schema":{"type":"string"}},{"description":"Specify a field for sorting results.","in":"query","name":"sort","schema":{"type":"string"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/app_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Get a listing of app memberships. For organization admins, all app memberships for the entire organization are available to view. For all other users, your own app memberships are available.\n","operationId":"get_app_memberships","summary":"Get a Listing of App Memberships"}},"/apps/app_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Delete an app membership, specified by membership ID. Requires organization admin permission.\n","operationId":"delete_app_membership","summary":"Delete a Specific App Membership"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Get information about a specific app membership, specified by membership ID.\n","operationId":"get_app_membership_by_id","summary":"Get Information About a Specific App Membership"}},"/apps/{aspera_app_type}/app_memberships":{"post":{"parameters":[{"in":"path","name":"aspera_app_type","required":true,"schema":{"enum":["activity","automation"],"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Create an app membership. Requires organization admin permission.\n","operationId":"add_app_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_params"}}},"required":true},"summary":"Create a New App Membership"}},"/client_access_keys":{"get":{"parameters":[{"in":"query","name":"node_id","schema":{"type":"string"}},{"in":"query","name":"root_file_id","schema":{"type":"string"}},{"in":"query","name":"permission_id","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/client_access_keys_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Get a listing of client access keys for your organization.","operationId":"get_client_access_keys","summary":"Get a Listing of Client Access Keys"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Create a client access key.","operationId":"add_client_access_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_params"}}},"required":true},"summary":"Register a New Client Access Key with Aspera on Cloud"}},"/client_access_keys/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Delete a client access key, specified by ID.","operationId":"delete_client_access_key","summary":"Delete a Specific Client Access Key"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Get information about a specific client access key, specified by ID.\n","operationId":"get_client_access_key_by_id","summary":"Get Information About a Specific Client Access Key"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Update the name of a client access key.","operationId":"update_client_access_key","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"The name of the client access key.","example":"MyAccessKey","type":"string"}},"type":"object"}}},"required":true},"summary":"Update the Name of a Client Access Key"}},"/client_authorizations":{"get":{"parameters":[{"in":"query","name":"client_id","schema":{"type":"string"}},{"in":"query","name":"entity_id","schema":{"type":"string"}},{"in":"query","name":"entity_type","schema":{"type":"string"}},{"description":"embed[]=entity (gives back entity which should be user/group)","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/client_authorizations_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Get a listing of information on all client whitelists.","operationId":"get_client_authorizations","summary":"Get a Listing of Information on all Client Whitelists"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Create an authorization for an API client. Each entity to authorize requires a separate request.","operationId":"add_client_authorization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_params"}}},"required":true},"summary":"Create a New Authorization"}},"/client_authorizations/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Delete a user from a client whitelist.","operationId":"delete_client_authorization","summary":"Delete a User from a Client Whitelist"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=entity (gives back entity which should be user/group)","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Retrieve a listing with information on all entities in the whitelist for a specific client.","operationId":"get_client_authorization_by_id","summary":"Get Information on Entities in a Whitelist for a Specific Client"}},"/clients":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/clients_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Get a listing of clients currently registered to use the Aspera on Cloud API.","operationId":"get_clients","summary":"Get a Listing of All Registered Clients"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Create an API client.","operationId":"add_client","requestBody":{"$ref":"#/components/requestBodies/clients_params"},"summary":"Register a New Client with the Files API"}},"/clients/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Delete a registered client, specified by client ID.","operationId":"delete_client","summary":"Delete a Specific Registered Client"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Get information about a specific registered client, specified by the client ID returned in the GET response.","operationId":"get_client_by_id","summary":"Get Information about a Specific Registered Client"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Update a registered client. For example, change the redirect URI and the admin node token retrieval parameters.","operationId":"update_client","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_params"}}},"required":true},"summary":"Modify a Registered Client"}},"/dropbox_memberships":{"get":{"parameters":[{"in":"query","name":"can_invite_submitters","schema":{"type":"boolean"}},{"in":"query","name":"can_receive_packages","schema":{"type":"boolean"}},{"in":"query","name":"can_submit_packages","schema":{"type":"boolean"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"creator_id","schema":{"type":"string"}},{"description":"Filters memberships with member_type = \"user\" by their \"deactivated\" attribute.\n","in":"query","name":"deactivated","schema":{"type":"boolean"}},{"in":"query","name":"dropbox_id","schema":{"type":"string"}},{"description":"embed%5B%5D=member (user or group object from member_id), embed%5B%5D=dropbox (dropbox object from dropbox_id)\n","in":"query","name":"embed%5B%5D","schema":{"type":"string"}},{"description":"Specifies whether or not to include inherited memberships in the response. Typically used when an admin is looking at the memberships for a particular member_id or when a user is looking at their own memberships.\n","in":"query","name":"inherited","schema":{"type":"boolean"}},{"in":"query","name":"manager","schema":{"type":"boolean"}},{"in":"query","name":"member.email","schema":{"type":"string"}},{"in":"query","name":"member.last_login_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"member.last_name","schema":{"type":"string"}},{"in":"query","name":"member.system_group","schema":{"type":"boolean"}},{"in":"query","name":"member_id","schema":{"type":"string"}},{"description":"Either \"user\" or \"group\"","in":"query","name":"member_type","schema":{"type":"string"}},{"description":"Search member.email, member.first_name, member.last_name, and member.name.\n","in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/dropbox_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Get a listing of information about the current members of a given dropbox.\n","operationId":"get_dropbox_memberships","summary":"Get a Listing of All Dropbox Members"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_params"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Add a user or group as a member of this dropbox.","operationId":"add_dropbox_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_params"}}},"required":true},"summary":"Add a Dropbox Member"}},"/dropbox_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Remove a direct dropbox membership. Note: If the user also has indirect membership through a group, the user will still have access to the dropbox.\n","operationId":"delete_dropbox_membership","summary":"Remove a Member from a Dropbox"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed%5B%5D=member (member object from member_id), embed%5B%5D=dropbox (dropbox object from dropbox_id)\n","in":"query","name":"embed%5B%5D","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Get information on a specific dropbox membership.","operationId":"get_dropbox_membership_by_id","summary":"Get Information on a Specific Dropbox Membership"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Update an existing dropbox membership.","operationId":"update_dropbox_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_update_params"}}},"required":true},"summary":"Update a Dropbox Membership"}},"/dropboxes":{"get":{"parameters":[{"description":"Time at which the shared inbox was created.","in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"description":"Time at which the shared inbox was last updated.","in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"description":"Searches across shared inbox descriptions and names.","in":"query","name":"q","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/dropboxes_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Retrieve a listing of all shared inboxes.","operationId":"get_dropboxes","summary":"Get a Listing of All Shared Inboxes"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Create a new shared inbox.","operationId":"add_dropbox","requestBody":{"$ref":"#/components/requestBodies/dropboxes_params"},"summary":"Create a New Shared Inbox"}},"/dropboxes/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Delete a specific shared inbox, specified by shared inbox ID.","operationId":"delete_dropbox","summary":"Delete a Specific Shared Inbox"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Retrieve information on a specific shared inbox.","operationId":"get_dropbox_by_id","summary":"Get Information on a Specific Shared Inbox"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Make changes to an existing shared inbox.","operationId":"update_dropbox","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_params"}}},"required":true},"summary":"Update a Shared Inbox"}},"/nodes":{"get":{"parameters":[{"in":"query","name":"access_key","schema":{"type":"string"}},{"in":"query","name":"host","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"path","schema":{"type":"string"}},{"in":"query","name":"port","schema":{"type":"string"}},{"description":"Full text search that will show transfer nodes with matching access_key, host, name, path, or port.","in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/nodes_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Get information about all transfer nodes belonging to your organization.","operationId":"get_nodes","summary":"Get a Listing of All Nodes"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Create a new transfer node. User must be an organization admin.","operationId":"add_node","requestBody":{"$ref":"#/components/requestBodies/nodes_params"},"summary":"Create a New Node"}},"/nodes/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Delete a specific transfer node, as specified by node ID. User must be an organization admin.","operationId":"delete_node","summary":"Delete a Specific Node"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Retrieve information about a specific transfer node.","operationId":"get_node_by_id","summary":"Get Information on a Specific Node"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Make changes to an existing transfer node. User must be an organization admin.","operationId":"update_node","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_params"}}},"required":true},"summary":"Update a Node"}},"/organizations/{id}":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/organizations"],"description":"Retrieve information about your organization.","operationId":"get_organization","summary":"Get Information About Your Organization"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/organizations"],"description":"Make changes to your organization. Must be an organization admin to access.\n","operationId":"update_organization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_params"}}},"required":true},"summary":"Update Your Organization"}},"/packages":{"get":{"parameters":[{"in":"query","name":"complete","schema":{"type":"boolean"}},{"in":"query","name":"completed","schema":{"type":"boolean"}},{"in":"query","name":"completed_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deleted","schema":{"type":"boolean"}},{"in":"query","name":"dropbox_id","schema":{"type":"string"}},{"in":"query","name":"expired","schema":{"type":"boolean"}},{"in":"query","name":"failed","schema":{"type":"boolean"}},{"in":"query","name":"draft","schema":{"type":"boolean"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"sent_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deleted_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"size","schema":{"type":"integer"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}},{"in":"query","name":"sender_email","schema":{"type":"string"}},{"in":"query","name":"sender_id","schema":{"type":"string"}},{"in":"query","name":"sender_name","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"archived","schema":{"type":"boolean"}},{"in":"query","name":"read","schema":{"type":"boolean"}},{"in":"query","name":"received","schema":{"type":"boolean"}},{"in":"query","name":"sent","schema":{"type":"boolean"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"include_draft","schema":{"type":"boolean"}},{"in":"query","name":"exclude_dropbox_packages","schema":{"type":"boolean"}},{"in":"query","name":"has_content","schema":{"type":"boolean"}},{"description":"embed[]=node (node from node_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/packages_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Get information about all packages or retrieve packages sent to me in a specific workspace, sent to me as individual (not as a member of a dropbox), that are not archived and not deleted if the user ID is included in the token sent with the call.","operationId":"get_packages","summary":"Get a Listing of All Packages"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Recipient can be an individual user, workspace, or a dropbox.","operationId":"add_package","requestBody":{"$ref":"#/components/requestBodies/packages_params"},"summary":"Create Package to Send"}},"/packages/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Use package_id to delete the contents of a specific package. This action removes package contents permanently, but retains information on the package: sender, recipients, size, date, metadata if any, download history, and transfer specs like rate.","operationId":"delete_package","summary":"Delete a Specific Package"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=node (node from node_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Get information on a specific package.","operationId":"get_package_by_id","summary":"Get Information on a Specific Package"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Use the PUT method to mark the package \"sent=true\", including the proper number of transfers in the \"transfers_expected\" field, after the transfers have completed. The number of transfers expected depends on the number of discrete source locations of package contents.","operationId":"update_package","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_params"}}},"required":true},"summary":"Update a package"}},"/usage_reports":{"get":{"parameters":[{"in":"query","name":"node_id","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}},{"in":"query","name":"reporting_period_started_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"reporting_period_ended_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/usage_reports_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/usage_reports"],"description":"Get a listing of usage reports.","operationId":"get_usage_reports","summary":"Get a Listing of Usage Reports"}},"/users":{"get":{"parameters":[{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deactivated","schema":{"type":"boolean"}},{"in":"query","name":"email","schema":{"type":"string"}},{"in":"query","name":"first_name","schema":{"type":"string"}},{"in":"query","name":"last_login_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"last_name","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"organization_admin","schema":{"type":"boolean"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"description":"embed[]=home_node embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/users_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Get a list of information about all users.","operationId":"get_users","summary":"Get a Listing of Users"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Create a new user.","operationId":"add_user","requestBody":{"$ref":"#/components/requestBodies/users_params"},"summary":"Create a New User"}},"/users/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Delete a specific user.","operationId":"delete_user","summary":"Delete a Specific User"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=home_node embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Get Information on a specific user.","operationId":"get_user_by_id","summary":"Get Information on a Specific User"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Make a change to an existing user; for example, make a user an administrator.","operationId":"update_user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_params"}}},"required":true},"summary":"Update a Specific User Record"}},"/workspace_memberships":{"get":{"parameters":[{"in":"query","name":"can_invite_by_email","schema":{"type":"boolean"}},{"in":"query","name":"manager","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"integer"}},{"in":"query","name":"storage_allowed","schema":{"type":"boolean"}},{"description":"embed[]=user (user object from user_id) embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/workspace_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Get information about the current members of a given workspace.","operationId":"get_workspace_memberships","summary":"Get a Listing of All Workspace Members"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Add a user as a member of this workspace.","operationId":"add_workspace_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_params"}}},"required":true},"summary":"Add a User as a Workspace Member"}},"/workspace_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Remove a direct workspace membership. Note: If the user has indirect membership, through a group for example, the user still has access to the workspace.","operationId":"delete_workspace_membership","summary":"Remove a Member from a Workspace"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=user (user object from user_id) embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Get information on a specific membership.","operationId":"get_workspace_membership_by_id","summary":"Get Information on a Specific Membership"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Make an existing workspace member a workspace manager.","operationId":"update_workspace_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_update_params"}}},"required":true},"summary":"Update a Workspace Membership"}},"/workspaces":{"get":{"parameters":[{"description":"datetime","in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"node_id","schema":{"type":"integer"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"manager","schema":{"type":"boolean"}},{"description":"embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/workspaces_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Retrieve a listing of all configured workspaces.","operationId":"get_workspaces","summary":"Get a Listing of All Workspaces"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Create a new workspace.","operationId":"add_workspace","requestBody":{"$ref":"#/components/requestBodies/workspaces_params"},"summary":"Create a New Workspace"}},"/workspaces/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Delete a specific workspace, specified by workspace ID.","operationId":"delete_workspace","summary":"Delete a specific Workspace"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Retrieve information on a specific workspace.","operationId":"get_workspace_by_id","summary":"Get Information on a Specific Workspace"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Make changes to an existing workspace; for example, change collaboration settings.","operationId":"update_workspace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_params"}}},"required":true},"summary":"Update a Workspace"}}},"components":{"requestBodies":{"clients_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_params"}}},"required":true},"dropboxes_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_params"}}},"required":true},"nodes_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_params"}}},"required":true},"packages_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_params"}}},"required":true},"users_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_params"}}},"required":true},"workspaces_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_params"}}},"required":true}},"schemas":{"app_memberships_params":{"properties":{"member_id":{"description":"The ID of the member that this membership belongs to.","example":"27","type":"string"},"member_type":{"description":"The type of member that this membership belongs to.","enum":["user","group"],"example":"user","type":"string"}},"type":"object"},"app_memberships_response":{"properties":{"app_name":{"description":"Name of the app that the membership belongs to.","example":"Activity","type":"string"},"app_type":{"description":"Type of app that the membership belongs to.","enum":["activity","automation"],"example":"activity","type":"string"},"id":{"description":"ID of the app membership.","example":"372","type":"string"},"member_id":{"example":"213","type":"string"},"member_type":{"enum":["user","group"],"example":"user","type":"string"}},"type":"object"},"client_access_keys_params":{"properties":{"id":{"description":"ID of the client access key.","example":"999","type":"string"},"name":{"description":"Name of the client access key.","example":"MyAccessKey","type":"string"},"node_id":{"description":"ID of the transfer node that the client access key belongs to.","example":"42","type":"string"},"permission_id":{"example":null,"type":"string"},"root_file_id":{"description":"ID of the directory that this access key grants permissions for.\n","example":"bar","type":"string"}},"required":["id","root_file_id","node_id"],"type":"object"},"client_access_keys_response":{"properties":{"created_at":{"description":"Date at which the client access key was created.","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"id":{"description":"ID of the client access key.","example":"999","type":"string"},"name":{"description":"Name of the client access key.","example":"MyAccessKey","type":"string"},"node_id":{"description":"ID of the transfer node that the client access key belongs to.","example":"42","type":"string"},"permission_id":{"example":null,"type":"string"},"root_file_id":{"description":"ID of the directory that this access key grants permissions for.\n","example":"bar","type":"string"},"updated_at":{"description":"Date when the client access key was last updated.","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"workspace_id":{"description":"ID of the workspace that the client access key belongs to.","example":"24","type":"string"}},"type":"object"},"client_authorizations_params":{"properties":{"client_id":{"description":"The ID of the client.","example":"23749","type":"string"},"entity_id":{"description":"The ID of the entity that can be authorized.","example":0,"type":"integer"},"entity_type":{"description":"The type of entity who can be authorized. Default is user.\n","enum":["user","group"],"example":"user","type":"string"}},"required":["client_id","entity_type","entity_id"],"type":"object"},"client_authorizations_response":{"properties":{"client_id":{"description":"The ID of the client.","example":"0","type":"string"},"created_at":{"description":"The timestamp of authorization.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"entity_id":{"description":"The ID of the entity that can be authorized.","example":151,"type":"integer"},"entity_type":{"description":"The type of entity who can be authorized. Default is user.\n","enum":["user","group"],"example":"user","type":"string"},"id":{"description":"The client ID","example":"23749","type":"string"},"updated_at":{"description":"The timestamp of the most recent update.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"}},"type":"object"},"clients_params":{"properties":{"admin_node_token_retrieval_enabled":{"description":"If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Admin permissions required. Defaults to false.","example":false,"type":"boolean"},"explicit_authorization_required":{"description":"Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Admin permissions required. Defaults to true.","example":true,"type":"boolean"},"jwt_grant_enabled":{"description":"Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Admin permissions required.","example":false,"type":"boolean"},"name":{"description":"The name of the client app to register. Admin permissions required. POST: required. PUT: not required.","example":"AoC_Client","type":"string"},"origins":{"description":"The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Array of JSON origins (strings) Admin permissions required. Separate multiple origins with commas. Maximum characters: 65535.","example":["https://ClientOrigin.com"],"items":{"type":"string"},"type":"array"},"public_key":{"description":"RSA public key in PEM format. The corresponding private key can be used to generate a JWT assertion for any user in the organization. Admin permissions required. Maximum characters: 65535.","example":"-----BEGIN PUBLIC KEY-----\nMIIBI ... 7QIDAQAB\n-----END PUBLIC KEY-----","type":"string"},"redirect_uris":{"description":"The allowable list of redirect URIs for the client. A redirect URI (protocol-host-port) is an absolute URI invoked after the authentication flow to return the user to the client app. Array of JSON redirect URIs (strings) Admin permissions required. Separate multiple redirect URIs with commas. Maximum characters: 65535.","example":["https://ClientRedirect.com"],"type":"array","items":{"type":"string"}},"whitelist_enabled":{"description":"Enable creation of a specific list of users and groups eligible to receive an access token. To create the whitelist, see /client_authorizations. Admin permissions required. Pertains to JWT grants. Default is false.","example":true,"type":"boolean"}},"required":["name"],"type":"object"},"clients_response":{"properties":{"admin_node_token_retrieval_enabled":{"description":"If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Default is false.","example":true,"type":"boolean"},"allow_implicit_grant":{"description":"Whether or not to allow the client app to obtain an access token directly from the authorization endpoint, without contacting the token endpoint or authenticating the client.","example":false,"type":"boolean"},"created_at":{"description":"Timestamp of original creation of the client. Datetime.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"creator_id":{"description":"ID of the user who created the client.","example":"0","type":"string"},"explicit_authorization_required":{"description":"Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Default is true.","example":false,"type":"boolean"},"id":{"description":"ID of the client app.","example":"0","type":"string"},"jwt_grant_enabled":{"description":"Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Default is false.","example":false,"type":"boolean"},"name":{"description":"Name assigned to the client. Maximum length: 255 characters.","example":"AoC_Client","type":"string"},"organization_id":{"description":"ID of the AoC organization to which the client belongs.","example":"4","type":"string"},"origins":{"description":"The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Separate multiple origins with commas. Maximum characters: 65535. Array of json origins (strings).","example":["https://origins.com"],"items":{"type":"string"},"type":"array"},"public_key":{"description":"The public portion of the RSA key pair. Maximum characters: 65535.","example":"-----BEGIN PUBLIC KEY-----\nMIIBI ... 7QIDAQAB\n-----END PUBLIC KEY-----","type":"string"},"redirect_uris":{"description":"The allowable list of redirect URIs for this client. A redirect URI, or protocol-host-port, is an absolute URI invoked after the authentication flow to return the user to the client app. Separate multiple redirect URIs with commas. Maximum characters: 65535.","example":["https://redirect.com"],"type":"array","items":{"type":"string"}},"secret":{"description":"The secret associated with this client.","example":"Fw62_Lh7qOK9Z62z-TAwqJncr8Lmej97TbFCnhzd9ShdQ25NxKuLjeOJXSkKrOHuRezeKiXXcuCUoh_hJ1wwzHARdElfsDhw","type":"string"},"updated_at":{"description":"Timestamp of last modification to the client. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"whitelist_enabled":{"description":"Enable creation of a specific list of users and groups eligible to receive an access token. Pertains to JWT grants. Default is false. See /client_authorizations.","example":false,"type":"boolean"}},"type":"object"},"dropbox_memberships_params":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"dropbox_id":{"description":"ID of the dropbox to which this membership belongs.","example":"123","type":"string"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"member_id":{"description":"ID of the member to which this membership belongs.","example":"42","type":"string"},"member_type":{"description":"Describes the kind of member to which this membership belongs.\n","enum":["user","group"],"example":"user","type":"string"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"}},"required":["dropbox_id","member_id"],"type":"object"},"dropbox_memberships_response":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"creator_id":{"description":"ID of the user who created this membership.","example":"42","type":"string"},"dropbox_id":{"description":"ID of the dropbox to which this membership belongs.","example":"123","type":"string"},"id":{"description":"ID of this dropbox membership.","example":"42","type":"string"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"member_id":{"description":"ID of the member to which this membership belongs.","example":"42","type":"string"},"member_type":{"description":"Describes the kind of member to which this membership belongs.\n","enum":["user","group"],"example":"user","type":"string"},"submit_expired":{"description":"Indicates whether the member may make a submission to the dropbox.\n","example":false,"type":"boolean"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace to which this dropbox membership belongs.\n","example":"123","type":"string"}},"type":"object"},"dropbox_memberships_update_params":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"}},"type":"object"},"dropboxes_params":{"properties":{"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"custom_notification_list_enabled":{"description":"For a package sent to a shared inbox, this parameter determines whether notifications are sent to all package addressees or to a user-defined list of addressees for the shared inbox (see dropbox_notification_recipients). Defaults to false. Valid values: true to send notifications to a user-defined list or false to send notifications to all package addressees. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured by this parameter has passed, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the delete_package_content_after_download_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"description":{"description":"A description for the shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":null,"type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this shared inbox by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"dropbox_notification_recipients":{"description":"With custom_notification_list_enabled = true, this parameter defines a list of addressees who should receive notifications regarding packages addressed to this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"id":"email@foo.co","type":"email"}],"items":{"properties":{"id":{"description":"For type = user | group, id denotes the integer ID of that user or group (e.g., \"123\"). For type = email, id denotes the email address of the intended addressee (e.g., \"email@foo.co\").\n","type":"string"},"type":{"enum":["user","group","email"],"type":"string"}},"type":"object"},"type":"array"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notifications specification. See below. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","type":"object"},"enable_external_email_templates":{"description":"If inherit_email_templates is set to false, you can enable or disable the ability to configure email templates specifically for users outside this shared inbox. When this parameter is set to false, external recipients receive the same email notification messages that users in the shared inbox receive. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"image_data":{"description":"The image data for the shared inbox logo encoded as a string. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the shared inbox logo. For example, image/png or image/jpg. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"image/png","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the workspace level. POST Admin or Manager permission required. PUT Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Inherit the email templates configured at the workspace level. If false, you can configure email template settings for this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_workspace_expiration_settings":{"description":"Inherit the content_retention_duration settings configured at the workspace level. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"instructions":{"description":"User-defined instructions for potential shared inbox submissions. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"Video submissions only.","type":"string"},"metadata_schema":{"$ref":"#/components/schemas/metadata"},"name":{"description":"Shared inbox name. A query parameter for the GET method. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"My Shared Inbox","type":"string"},"package_name_and_message_validation_schema":{"description":"Defines illegal characters and/or max length for the name and message fields for package submissions to this shared inbox. Defaults to an empty array ([]). POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"field_name":"package_name","illegal_characters":"!@#","max_length":"100"},{"field_name":"package_message","illegal_characters":"!@#","max_length":"50"}],"items":{"properties":{"field_name":{"enum":["package_name","package_message"],"type":"string"},"illegal_characters":{"description":"Defines all disallowed characters.","example":"!@#","type":"string"},"max_length":{"description":"Defines the max length for the provided string.","example":"50","type":"string"}},"type":"object"},"type":"array"},"personalized_urls_enabled":{"description":"Enable members of this shared inbox to configure personalized URLs to send when inviting people to submit packages. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"workspace_id":{"description":"ID of the workspace to which this shared inbox belongs. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"123","type":"string"}},"required":["name","description","instructions","workspace_id"],"type":"object"},"dropboxes_response":{"properties":{"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. Write only.\n","example":null,"type":"integer"},"custom_notification_list_enabled":{"description":"For a package sent to a shared inbox, this configuration determines whether notifications are sent to all package addressees or a user-defined list of addressees for the shared inbox (see dropbox_notification_recipients). Defaults to false. Valid values: true to send notifications to a user-defined list or false to send notifications to all package addressees. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured by this parameter has passed, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the delete_package_content_after_download_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"description":{"description":"A description for the shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":null,"type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this shared inbox by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"dropbox_notification_recipients":{"description":"With custom_notification_list_enabled = true, this parameter defines a list of addressees who should receive notifications regarding packages addressed to this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"id":"email@foo.co","type":"email"}],"items":{"properties":{"id":{"description":"For type = user | group, id denotes the integer ID of that user or group (e.g., \"123\"). For type = email, id denotes the email address of the intended addressee (e.g., \"email@foo.co\").\n","type":"string"},"type":{"enum":["user","group","email"],"type":"string"}},"type":"object"},"type":"array"},"effective_content_retention_duration":{"description":"Amount of time in seconds it takes for packages in this shared inbox to be deleted once their transfers complete. If null, packages will not be deleted on a timer. Read-only.\n","example":null,"type":"integer"},"effective_delete_package_content_after_download_duration":{"description":"Amount of time in seconds it takes a package in this shared inbox to be deleted once all recipients have downloaded the entire package. If null, packages will not be deleted on a timer. Read-only.\n","example":null,"type":"integer"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notifications specification. See below. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","type":"object"},"enable_external_email_templates":{"description":"If inherit_email_templates is set to false, you can enable or disable the ability to configure email templates specifically for users outside this shared inbox. When this parameter is set to false, external recipients receive the same email notification messages that users in the shared inbox receive. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"id":{"description":"The ID of the shared inbox. Read-only.","example":"123","type":"string"},"image_url":{"description":"The URL of the shared inbox logo image. Read-only.","example":"https://api.asperafiles.com/api/v1/user_images/32850?oh=cg-nf7pFnNK0-N3g3r-f2nRg","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the workspace level. POST Admin or Manager permission required. PUT Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Inherit the email templates configured at the workspace level. If false, you can configure email template settings for this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_workspace_expiration_settings":{"description":"Inherit the content_retention_duration settings configured at the workspace level. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"instructions":{"description":"User defined instructions for potential shared inbox submissions. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"Video submissions only.","type":"string"},"metadata_schema":{"$ref":"#/components/schemas/metadata"},"name":{"description":"shared inbox name. A query parameter for the GET method. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"My Dropbox","type":"string"},"package_name_and_message_validation_schema":{"description":"Defines illegal characters and/or max length for the name and message fields for package submissions to this shared inbox. Defaults to an empty array ([]). POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"field_name":"package_name","illegal_characters":"!@#","max_length":"100"},{"field_name":"package_message","illegal_characters":"!@#","max_length":"50"}],"items":{"properties":{"field_name":{"enum":["package_name","package_message"],"type":"string"},"illegal_characters":{"description":"Defines all disallowed characters.","example":"!@#","type":"string"},"max_length":{"description":"Defines the max length for the provided string.","example":"50","type":"string"}},"type":"object"},"type":"array"},"personalized_urls_enabled":{"description":"Enable members of this shared inbox to configure personalized URLs to send when inviting people to submit packages. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"recipients_group_id":{"description":"ID of the group that all shared inbox recipients belong to. Read-only.\n","example":"123","type":"string"},"senders_group_id":{"description":"ID of the group that all senders to the shared inbox belong to. Read-only.\n","example":"123","type":"string"},"workspace_id":{"description":"ID of the workspace to which this shared inbox belongs. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"123","type":"string"}},"type":"object"},"email_notification_settings":{"properties":{"dropbox_invitation":{"description":"An email notification setting; refer to email_notification_settings. Notify users who receive an invitation to send a package to a dropbox. Refer also to public_invites_allowed(_by_managers).","example":true,"type":"boolean"},"file_shared":{"description":"An email notification setting; refer to email_notification_settings. Notify users who are recipients of a shared file. Refer also to public_links_allowed(_by_managers).","example":true,"type":"boolean"},"invitation_to_send_to_me":{"description":"An email notification setting; refer to email_notification_settings. Notifiy users who receive an invitation to send a package to an individual (as opposed to sending to a dropbox; see dropbox_invitation). Refer also to external_package_sending_allowed(_by_managers).","example":true,"type":"boolean"},"package_contents_deleted":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a package is deleted (senders or administrators can delete packages).","example":true,"type":"boolean"},"package_downloaded":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender when recipients have downloaded the package.","example":true,"type":"boolean"},"package_expired":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when package contents are deleted according to configured package expiration policy (see also delete_package_content_after_download_duration and content_retention_duration).","example":true,"type":"boolean"},"package_failed":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender when a package transfer has failed.","example":true,"type":"boolean"},"package_recalled":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a package has been recalled by the sender. When a package is recalled, the recipient cannot browse or download package contents until the sender resends the package.","example":true,"type":"boolean"},"package_received":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when they have received a package and the package is available.","example":true,"type":"boolean"},"package_resent":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a recalled package has been resent. The package will be available to the recipient when the transfer completes; at that point the recipient receives the package_received notification.","example":true,"type":"boolean"},"package_sent":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender that the package was successfully sent. The package will be available to the recipient when the transfer completes; at that point the recipient receives the package_received notification.","example":true,"type":"boolean"},"package_uploaded":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender that the package was successfully uploaded to the transfer server.","example":true,"type":"boolean"}},"type":"object"},"metadata":{"description":"A metadata schema is used to present a form to a user when the user is submitting content to a dropbox. It is an array with \"Field\" objects, and each Field object defines one field that the user can fill out when submitting content to a dropbox. Note that the order of the fields in the metadata schema array will be the order in which they are shown to the user.\n","example":[{"choices":["opt1","opt2","opt3"],"default_values":["opt2"],"input_type":"single-dropdown","name":"Field 1"}],"items":{"properties":{"choices":{"description":"The value(s) to be configured by the sender. Required for single-dropdown and multiple-checkbox.\n","example":["Option1","Option2"],"items":{"type":"string"},"type":"array"},"default_values":{"description":"Sets the singular default value for each input_type except multiple-checkbox. In the case of multiple-checkbox, a default value is set for each checkbox.\n","example":["Option2"],"items":{"type":"string"},"type":"array"},"illegal_characters":{"description":"Defines all disallowed characters for string fields.","example":"!@#","type":"string"},"input_type":{"description":"The type of the field.","enum":["single-text","date","textbox","single-dropdown","multiple-checkbox"],"type":"string"},"max_length":{"description":"For string fields defines the maximum number of characters allowed.\n","example":"100","type":"string"},"name":{"description":"The label of the metadata field.","type":"string"},"required":{"description":"Denotes a field as required.","example":true,"type":"boolean"}},"required":["name","input_type"],"type":"object"},"type":"array"},"nodes_params":{"properties":{"access_key":{"description":"Access keys are used for authorization when AoC makes a request via the Node API. Each transfer node must have a unique access key.\n","example":"abc123","type":"string"},"ats_access_key":{"description":"Indicates that access_key is a key for an Aspera Transfer Service node. Defaults to false. Used on POST only.\n","example":false,"type":"boolean"},"ats_storage_type":{"description":"For Aspera Transfer Service nodes, this field defines which type of storage is used.\n","enum":["aws_s3","azure","azure-files","azure_sas","google-gcs","ibm-s3","softlayer_swift"],"example":null,"type":"string"},"configuration_policy_id":{"description":"References the configuration policy to which a transfer node belongs.\n","example":null,"type":"integer"},"name":{"description":"User-defined identifier for the transfer node. Each transfer node must have a unique name.","example":"myNode","type":"string"},"network_policy_id":{"description":"References the network configuration policy to which a transfer node belongs.\n","example":null,"type":"integer"},"ssh_fingerprint":{"description":"If your node has SSH capabilities, used for verifying SSH connections.\n","example":null,"type":"string"},"status":{"description":"If a transfer node has status \"error\" but the problem has been fixed, it will automatically recover to the \"ok\" state. Similarly, if a node has status \"ok\", it will switch to status \"error\" automatically if there is a problem. Nodes with status \"down\" remain in the \"down\" state until marked \"ok\" by a user.\n","enum":["ok","error","down"],"example":"error","type":"string"},"url":{"description":"Specifies the URL where the transfer node is located. Necessary for AoC to make requests via the Node API.\n","example":"https://example.com","type":"string"},"use_ssl":{"description":"Describes node secure socket layer usage. Defaults to true.","example":true,"type":"boolean"},"verify_ssl_certificate":{"description":"Specifies whether or not node must verify SSL certificate. Defaults to true.\n","example":true,"type":"boolean"}},"type":"object"},"nodes_response":{"properties":{"host":{"description":"Host portion of node URL.","example":"example.com","type":"string"},"access_key":{"description":"Access keys are used for authorization when AoC makes a request via the Node API. Each transfer node must have a unique access key.\n","example":"abc123","type":"string"},"ats_access_key":{"description":"Indicates that access_key is a key for an Aspera Transfer Service node. Defaults to false. Used on POST only.\n","example":false,"type":"boolean"},"ats_storage_type":{"description":"For Aspera Transfer Service nodes, this field defines which type of storage is used.\n","enum":["aws_s3","azure","azure-files","azure_sas","google-gcs","ibm-s3","softlayer_swift"],"example":null,"type":"string"},"capabilities":{"items":{"properties":{"name":{"type":"string"},"value":{"nullable":true,"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}},"type":"object"},"type":"array"},"configuration_policy_id":{"description":"References the configuration policy to which a node belongs.\n","example":42,"type":"integer"},"error_message":{"description":"Short message describing the nature of the most recent transfer node error.\n","example":"502 Bad Gateway","type":"string"},"error_time":{"description":"Datetime. Indicates time of most recent error.","example":"2019-06-04T04:41:00.000Z","type":"string"},"name":{"description":"User-defined identifier for the transfer node. Each transfer node must have a unique name.","example":"myNode","type":"string"},"network_policy_id":{"description":"References the network configuration policy to which a transfer node belongs.\n","example":42,"type":"integer"},"path":{"description":"Path portion of the transfer node URL.","example":"/","type":"string"},"port":{"description":"Port portion of the transfer node URL.","example":9092,"type":"integer"},"settings":{"items":{"properties":{"name":{"type":"string"},"value":{"nullable":true,"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}},"type":"object"},"type":"array"},"ssh_fingerprint":{"description":"If your node has SSH capabilities, used for verifying SSH connections.\n","example":null,"type":"string"},"status":{"description":"If a transfer node has status \"error\" but the problem has been fixed, it will automatically recover to the \"ok\" state. Similarly, if a node has status \"ok\", it will switch to status \"error\" automatically if there is a problem. Nodes with status \"down\" remain in the \"down\" state until marked \"ok\" by a user.\n","enum":["ok","error","down"],"example":"error","type":"string"},"url":{"description":"Specifies the URL where the transfer node is located. Necessary for AoC to make requests via the Node API.\n","example":"https://example.com:9092/","type":"string"},"use_ssl":{"description":"Describes node secure socket layer usage. Defaults to true.","example":true,"type":"boolean"},"verify_ssl_certificate":{"description":"Specifies whether or not node must verify SSL certificate. Defaults to true.\n","example":true,"type":"boolean"}},"type":"object"},"organizations_params":{"properties":{"background_image_data":{"description":"Data for the image to be displayed on the organization sign-in page. The data must be binary and have a maximum size of 4MB. Returned only when image_data is included in the request (e.g., include%5B%5D=image_data).\n","example":null,"type":"string"},"background_image_type":{"description":"The file type of the background image.","example":"image/gif","type":"string"},"consecutive_login_failures_limit":{"description":"The number of login failures allowed before the user is required to change passwords. Valid values: 2 - 10. Requires organization admin permission to view or update.\n","example":2,"type":"integer"},"default_ear_setting":{"description":"Indicates the default encryption-at-rest setting for your organization. Defaults to false. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"email_footer":{"description":"Text to be added as the footer in email notifications sent for your organization. Must have organization admin permission to view or update.\n","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Must have organization admin permission to view or update."},"enable_external_email_templates":{"description":"Indicates whether the organization has external email templates enabled. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"enforce_password_history_count":{"description":"The number of password changes that must occur before a password can be reused. Valid values are 1 - 12, or null to disable. Requires organization admin permission to view or update.\n","example":3,"type":"integer"},"event_reporting_uri":{"description":"Customer-configurable endpoint that can receive reporting for AoC events. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"google_excluded_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with google_included_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"google_included_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with google_excluded_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"google_oauth_included":{"description":"Indicates whether users can be authenticated through Google OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"inherit_email_templates":{"description":"Indicates whether this organization is using customized email templates. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"invitation_message":{"description":"Text for the email notification that is sent to new users when they are invited to join your organization. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"local_excluded_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with local_included_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"local_included_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with local_excluded_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"local_login_button_text":{"description":"Customized text that will appear on the local login button. Requires organization admin permission to view or update.\n","example":"Log into MyOrganization!","type":"string"},"local_oauth_enabled":{"description":"Indicates whether users can be authenticated through local OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"logo_image_data":{"description":"Data for the image to be used as the organization logo. The data must be binary and have a maximum size of 512KB. This field is included only when the query string includes \"include%5B%5D=image_data\".\n","example":null,"type":"string"},"logo_image_type":{"description":"The data type of the provided logo image.","example":"image/gif","type":"string"},"minimum_password_age":{"description":"Defines the minimum age for a password before it can be reset. Units: seconds. Valid values: 15 minutes to 1 year (900 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":900,"type":"integer"},"minimum_password_length":{"description":"The minimum length for passwords for users in your organization. Valid values: 8 - 100. Requires organization admin permission to view or update.\n","example":8,"type":"integer"},"name":{"description":"The name of your organization.","example":"MyOrganization","type":"string"},"new_user_password_reset_token_duration":{"description":"How long a password reset link is valid, when it is sent as part of an invitation to a new user. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"node_token_duration":{"description":"Denotes the amount of time that a transfer node access token is valid. Must be at least as long as access_token_duration. Units: seconds. Valid values: 1 hour - 14 days (3600 - 1209600). Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"organization_contacts_visible_to_managers":{"description":"If true, workspace managers can see all organization contacts. Otherwise, workspace managers can only see the contacts for their workspace. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"password_expiration_interval":{"description":"How often a password change is required. Units: seconds. Valid values: 15 days to 1 year (129600 - 31536000) or null to disable. Requires organization admin permission to view or update.\n","example":129600,"type":"integer"},"password_reset_token_duration":{"description":"How long the password reset link is good for. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"require_strong_passwords":{"description":"Indicates whether to require users to set \"strong\" passwords. A \"strong\" password contains at least three of the following: 1. A lowercase letter 2. An uppercase letter 3. A non-word character (!, @, #, etc.) 4. A number. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"session_duration":{"description":"How long a user can be inactive before their session is terminated and their access token is invalidated. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable.\n","example":3600,"type":"integer"},"sign_on_message":{"description":"Message displayed to users on sign-in.","example":"Welcome to MyOrganization!","type":"string"},"workspace_container_node_id":{"description":"When creating a workspace, node_id is required, but the client app can choose to use this value as a default. This is set automatically to the first transfer node created in your organization. Requires organization admin permission to view or update.\n","example":"2","type":"string"}},"type":"object"},"organizations_response":{"properties":{"access_token_duration":{"description":"How long an access token is valid. Units: seconds. Valid values: 3600 - 86400 (1 - 24 hours). Viewable by organization admin only.\n","example":3600,"type":"integer"},"access_token_refresh_duration":{"description":"The maximum amount of time that can pass in which an access token can be refreshed. Units: seconds. Valid values: 3600 - 1209600 (1 hour - 14 days), or null to disable access token refreshing. Viewable by organization admin only.\n","example":3600,"type":"integer"},"background_image_data":{"description":"Data for the image to be displayed on the organization sign-in page. The data must be binary and have a maximum size of 4MB. Returned only when image_data is included in the request (e.g. include%5B%5D=image_data).\n","example":null,"type":"string"},"background_image_type":{"description":"The file type of the background image.","example":"image/gif","type":"string"},"background_image_url":{"description":"The URL at which the background image is stored.","example":null,"type":"string"},"consecutive_login_failures_limit":{"description":"The number of login failures allowed before the user is required to change passwords. Valid values: 2 - 10. Requires organization admin permission to view or update.\n","example":2,"type":"integer"},"created_at":{"description":"The time at which the organization was created. Viewable by organization admin only.\n","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"default_ear_setting":{"description":"Indicates the default encryption-at-rest setting for your organization. Defaults to false. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"default_local_login_button_text":{"description":"The default text that appears on the local login button. Viewable by organization admin only.\n","example":"Log in","type":"string"},"email_footer":{"description":"Text to be added as the footer in email notifications sent for your organization. Must have organization admin permission to view or update.\n","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Must have organization admin permission to view or update."},"enable_external_email_templates":{"description":"Indicates whether the organization has external email templates enabled. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"enforce_password_history_count":{"description":"The number of password changes that must occur before a password can be reused. Valid values are 1 - 12, or null to disable. Requires organization admin permission to view or update.\n","example":3,"type":"integer"},"event_reporting_uri":{"description":"Customer-configurable endpoint that can receive reporting for AoC events. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"google_excluded_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with google_included_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"google_included_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with google_excluded_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"google_oauth_included":{"description":"Indicates whether users can be authenticated through Google OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"id":{"description":"The ID of your organization. Read-only.","example":"4","type":"string"},"inherit_email_templates":{"description":"Indicates whether this organization is using customized email templates. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"invitation_message":{"description":"Text for the email notification that is sent to new users when they are invited to join your organization. Requires organization admin permission to view or update.","example":null,"type":"string"},"local_excluded_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with local_included_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"local_included_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with local_excluded_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"local_login_button_text":{"description":"Customized text that will appear on the local login button. Requires organization admin permission to view or update.\n","example":"Log into MyOrganization!","type":"string"},"local_oauth_enabled":{"description":"Indicates whether users can be authenticated through local OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"logo_image_data":{"description":"Data for the image to be used as organization logo. The data must be binary and have a maximum size of 512KB. This field is included only when the query string includes \"include%5B%5D=image_data\".\n","example":null,"type":"string"},"logo_image_type":{"description":"The data type of the provided logo image.","example":"image/gif","type":"string"},"logo_image_url":{"description":"The URL at which your logo image is stored. Read-only.","example":null,"type":"string"},"minimum_password_age":{"description":"Defines the minimum age for a password before it can be reset. Units: seconds. Valid values: 15 minutes to 1 year (900 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":900,"type":"integer"},"minimum_password_length":{"description":"The minimum length for passwords for users in your organization. Valid values: 8 - 100. Requires organization admin permission to view or update.\n","example":8,"type":"integer"},"name":{"description":"The name of your organization.","example":"MyOrganization","type":"string"},"new_user_password_reset_token_duration":{"description":"How long a password reset link is valid, when it is sent as part of an invitation to a new user. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"node_token_duration":{"description":"Denotes the amount of time that a transfer node access token is valid. Must be at least as long as access_token_duration. Units: seconds. Valid values: 1 hour - 14 days (3600 - 1209600). Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"oauth_token_verification_key":{"description":"RSA public key used to verify OAuth tokens for this org. Requires organization admin permission to view. Read-only.\n","example":"-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n","type":"string"},"organization_contacts_visible_to_managers":{"description":"If true, workspace managers can see all organization contacts. Otherwise, workspace managers can see only the contacts for their workspace. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"password_expiration_interval":{"description":"How often a password change is required. Units: seconds. Valid values: 15 days to 1 year (129600 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":129600,"type":"integer"},"password_reset_token_duration":{"description":"How long the password reset link is valid. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"require_strong_passwords":{"description":"Indicates whether to require users to set \"strong\" passwords. A \"strong\" password contains at least three of the following: 1. A lowercase letter 2. An uppercase letter 3. A non-word character (!, @, #, etc.) 4. A number. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"session_duration":{"description":"How long a user can be inactive before their session is terminated and their access token is invalidated. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable.\n","example":3600,"type":"integer"},"sign_on_message":{"description":"Message displayed to users on sign-in.","example":"Welcome to MyOrganization!","type":"string"},"subdomain_name":{"description":"The subdomain name for your organization. Read-only.","example":"ibm","type":"string"},"tier":{"description":"The tier of your organization's Aspera on Cloud subscription. Can be any of \"paygo\", \"standard\", \"advanced\", or \"enterprise\". Read-only.\n","example":"standard","type":"string"},"trial_expires_at":{"description":"For organizations on trial subscriptions, this denotes the time at which their subscription ends. Is null in all other cases. Read-only.\n","example":null,"format":"date-time","type":"string"},"url_id":{"description":"The URL ID for your organization. Read-only.","example":"abc123","type":"string"},"workspace_container_node_id":{"description":"When creating a workspace, node_id is required, but the client app can choose to use this value as a default. This is set automatically to the first transfer node created in your organization. Requires organization admin permission to view or update.\n","example":"2","type":"string"}},"type":"object"},"packages_params":{"properties":{"archived":{"description":"Whether or not this package has been archived by the user.","example":false,"type":"boolean"},"bcc_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"content_retention_duration":{"description":"When a time-based content expiration value is set for this package, the duration to retain packages contents. When this duration passes, the packages contents are deleted. Valid values are null to 10 years. Units are seconds.","example":null,"type":"integer"},"delete_package_content_after_download_duration":{"description":"If 'delete_after_download' is set to 'true', this parameter configures an optional 'grace period', during which the package contents will be retained even after all recipients have downloaded the package. The timer for this setting begins when all recipients have downloaded the package; when the timer expires, the package contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"download_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"draft":{"description":"Whether or not the package is in draft status.","example":true,"type":"boolean"},"encryption_at_rest":{"description":"Whether or not the package has encryption_at_rest applied. For transfers that use the Aspera Connect transfer client, note this requirement to enable Connect to decrypt package contents. When a package is uploaded with encryption-at-rest set to true, the parameter single-source must also be true.","example":false,"type":"boolean"},"file_names":{"description":"The names of the items to include in this package; multiple names separated by commas. Maximum characters: 65535","example":"file.txt, file2.txt","type":"string"},"metadata":{"description":"JSON object. Maximum characters: 65535","example":"","type":"object"},"name":{"description":"Package name. Required for POST. Optional for PUT.","example":"Name of Package","type":"string"},"note":{"description":"The sender's message to recipients to include with the package. Maximum characters: 65535.","example":"Please review and process asap.","type":"string"},"read":{"description":"Whether or not the package was read.","example":false,"type":"boolean"},"recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"sent":{"description":"Whether or not the package was sent.","example":false,"type":"boolean"},"single_source":{"description":"Whether or not all the contents of this package originate from the same location (node, workstation, etc.). When the package recipient downloads a package with Encryption at Rest (EAR) applied by the sender, and all package contents are from the same source (single-source=true; for example, the sender's desktop; a specific remote server), AoC signals Aspera Connect to prompt the recipient to apply the passphrase created by the sender and decrypt package contents during the download operation. When package contents are from disparate sources, the recipient applies the password to individual files in the downloaded package when opening each file.","example":false,"type":"boolean"},"transfers_expected":{"description":"The number of transfer sessions expected to bring all package contents to the node supporting the workspace in which the package is sent. The number corresponds to the number of discrete source locations of the designated package contents. For example, if the package includes 20 files and folders from 5 discrete sources, the number of transfers expected is 5.","example":3,"type":"integer"},"upload_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"workspace_id":{"description":"The ID of the workspace from which this package was sent. Required for POST. Optional for PUT.","example":65,"type":"integer"}},"required":["name","workspace_id"],"type":"object"},"packages_response":{"properties":{"active_download_count":{"description":"The number of active downloads.","example":12,"type":"integer"},"archived":{"description":"Whether or not this package has been archived by the user. If user_package only.","example":false,"type":"boolean"},"average_rate":{"description":"Float. User Packages.","example":871.096,"type":"number"},"bcc":{"description":"Whether or not there is a BCC list. If user_package only.","example":true,"type":"boolean"},"bcc_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"bytes_transferred":{"description":"How many bytes have been transferred.","example":546,"type":"integer"},"complete":{"description":"Whether or not the package is fully available on the transfer node; when the package is complete, all transfers of the designated files and folders into the package have been successful and all designated files and folders are present on the node.","example":false,"type":"boolean"},"completed_at":{"description":"The timestamp that indicates when the package is complete. Refer to 'complete'.","example":"2018-02-06T00:05:25Z","format":"date-time","type":"string"},"content_expires_at":{"description":"The time at which package content will expire according to configured expiration policies. Refer to 'content_retention_duration' and to the related parameters 'delete_after_download' and 'delete_package_content_after_download_duration'.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"content_retention_duration":{"description":"When a time-based content expiration value is set for this package, the duration to retain packages contents. When this duration passes, the packages contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"contents_file_id":{"description":"The file ID on the node that contains package contents.","example":"479283475","type":"string"},"created_at":{"description":"The timestamp for when this package was created.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"delete_after_download":{"description":"Whether or not an expiration policy applies to this package, indicating that package contents will expire (be deleted) after all recipients have downloaded the package.","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"If 'delete_after_download' is set to 'true', this parameter configures an optional 'grace period', during which the package contents will be retained even after all recipients have downloaded the package. The timer for this setting begins when all recipients have downloaded the package; when the timer expires, the package contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"deleted":{"description":"Whether or not package contents have been deleted, either by the sender, by an administrator, or by configured expiration policies.","example":false,"type":"boolean"},"deleted_after_download":{"description":"Whether or not package contents were deleted by a download-based expiration policy.","example":false,"type":"boolean"},"deleted_at":{"description":"The timestamp for the deletion of package contents.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"deleted_by_admin":{"description":"Whether or not the deleted package was deleted by an administrator.","example":false,"type":"boolean"},"deleted_by_user_id":{"description":"The ID of the user who deleted the package.","example":151,"type":"integer"},"download_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"draft":{"description":"Whether or not the package is in draft status.","example":true,"type":"boolean"},"draft_expires_at":{"description":"The time the draft expired/expires.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"encryption_at_rest":{"description":"Whether or not the package has encryption_at_rest applied.","example":false,"type":"boolean"},"expiration_reason":{"description":"The reason for expiration. Package can be deleted by an administrator or by the sender, or can be deleted as a result of a configured time-based or download-based expiration policy.","example":"contents_expired","type":"string"},"expired":{"description":"Whether or not the package contents are expired due to a configured expiration policy.","example":false,"type":"boolean"},"expired_at":{"description":"The time the package expired/expires.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"failed":{"description":"Whether or not the transfer of this package failed.","example":false,"type":"boolean"},"failed_download_count":{"description":"The number of failed downloads of this package; download attempts may be full (the entire package) or partial (some contents of the package).","example":0,"type":"integer"},"file_count":{"description":"The number of files included in this package. This counts individual files included in the package, not files that are contents of folders that are included in the package.","example":21,"type":"integer"},"file_count_from_disk":{"description":"Whether or not the file_count value was obtained from the storage.","example":false,"type":"boolean"},"file_id":{"description":"The ID for the file comprising all package contents.","example":"7","type":"string"},"files_completed":{"description":"The number of files that have completed transferring.","example":46,"type":"integer"},"files_expected":{"description":"Number (obtained directly from the node) of files expected to be transferred as part of the package.","example":54,"type":"integer"},"folder_count":{"description":"The number of folders actually included in this package per the transfer session. This counts individual folder included in the package, not folders that are nested within other folders that are included in the package. This value may or may not match the value for folders_expected.","example":5,"type":"integer"},"folders_completed":{"description":"Number (obtained directly from the node) of folders successfully transferred as part of the package.","example":7,"type":"integer"},"folders_expected":{"description":"Number (obtained directly from the node) of folders expected to be transferred as part of the package.","example":8,"type":"integer"},"full_download_count":{"description":"The number of full downloads completed for this package. This counts the times that recipients have downloaded the package as a whole, rather than partial downloads, when a recipient downloads individual files or folders of a package.","example":4,"type":"integer"},"has_content":{"description":"Whether or not the package has contents. If content has been deleted, either by the user, by an administrator, or as the result of configured package expiration policies, the package record remains accessible, but the package content has been deleted from the transfer server and cannot be recovered.","example":false,"type":"boolean"},"id":{"description":"The ID for the package.","example":"87234","type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"name":{"description":"Package name.","example":"test package","type":"string"},"node_id":{"description":"The ID of the node that contains the package.","example":21,"type":"integer"},"note":{"description":"The sender's message to recipients to include with the package. Maximum characters: 65535.","example":"Please download and process asap. Thanks.","type":"string"},"package_sent":{"example":7},"read":{"description":"Whether or not the package was read. If user_package only.","example":false,"type":"boolean"},"recalled_at":{"description":"When the package was recalled.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"received":{"description":"Whether or not the package was received. If user_package only.","example":true,"type":"boolean"},"recipients":{"allOf":[{"$ref":"#/components/schemas/senders_recipients_object"}],"description":"If not user_package only."},"sender":{"$ref":"#/components/schemas/senders_recipients_object"},"sent":{"description":"Whether or not the package was sent.","example":true,"type":"boolean"},"sent_at":{"description":"The timestamp for when the package was sent.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"single_source":{"description":"Whether or not all the contents of this package originate from the same location (node, workstation, etc.). When the package recipient downloads a package with Encryption at Rest (EAR) applied by the sender or by workspace configuration, and all package contents are from the same source (for example, the sender's desktop; a specific remote server), AoC signals Aspera Connect to prompt the recipient to apply the passphrase created by the sender and decrypt package contents during the download operation. When package contents are from disparate sources, previous behavior applies: the recipient applies the password to individual files in the downloaded package when opening each file.","example":false,"type":"boolean"},"size":{"description":"The cumulative size of all the files and folders in the package.","example":345543,"type":"integer"},"time_remaining":{"description":"The time remaining to complete an in-progress transfer. Float.","example":1.3,"type":"number"},"transfers_expected":{"description":"The number of transfer sessions expected to bring all package contents to the node supporting the workspace in which the package is sent. The number corresponds to the number of discrete source locations of the designated package contents. For example, if the package includes 20 files and folders from 5 discrete sources, the number of transfers expected is 5.","example":7,"type":"integer"},"updated_at":{"description":"When the package was updated.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"upload_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"upload_started":{"description":"Whether or not the upload of the package has started.","example":false,"type":"boolean"},"upload_started_at":{"description":"The timestamp for when the package upload began.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace from which this package was sent.","example":64792,"type":"integer"}},"type":"object"},"senders_recipients_object":{"properties":{"id":{"description":"The ID of the recipient.","type":"string"},"type":{"description":"The entity type of the recipient.","enum":["user","group"],"type":"string"}},"required":["id"],"type":"object"},"usage_reports_response":{"properties":{"node_id":{"description":"The ID of the transfer node for which this usage report was generated.","example":"1","type":"string"},"reporting_period_bytes":{"description":"The total number of bytes transferred during this reporting period.\n","example":1024,"type":"integer"},"reporting_period_bytes_in":{"description":"The total number of bytes received during this reporting period.\n","example":512,"type":"integer"},"reporting_period_bytes_out":{"description":"The total number of bytes sent during this reporting period.","example":512,"type":"integer"},"total_bytes":{"description":"The total number of bytes transferred since the transfer node started collecting usage information.\n","example":2048,"type":"integer"},"total_bytes_in":{"description":"The total number bytes received since the transfer node started collecting usage information.\n","example":1024,"type":"integer"},"total_bytes_out":{"description":"The total number of bytes sent since the transfer node started collecting usage information.\n","example":1024,"type":"integer"},"updated_at":{"description":"The date at which this usage report was last updated.","example":"2019-06-18T21:46:36.000Z","format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace for which this usage report was generated.\n","example":"2","type":"string"}},"type":"object"},"users_params":{"properties":{"avatar_image_data":{"description":"PUT User, Manager, Admin for self.","type":"string"},"avatar_image_type":{"description":"The image type of the avatar image data. PUT User, Manager, Admin for self.","type":"string"},"deactivated":{"description":"Whether or not this user is deactivated. A deactivated user cannot log in to Aspera on Cloud, but still exists in the user database. PUT Admin permission required.","example":false,"type":"boolean"},"default_workspace_choice":{"description":"The workspace selected by the user as their default; when the user logs in to Aspera on Cloud, the default workspace displays. If the user has not selected a default workspace, the last used workspace displays. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"last_used","type":"string"},"default_workspace_id":{"description":"The ID of the user-selected default workspace. If the user has not selected a default workspace, the field contains the ID of the user's last used workspace. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"5988","type":"string"},"email":{"description":"The email address associated with this user in the AoC user database. This is the user's login username. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required. Required only for POST.","example":"email@example.com","type":"string"},"first_name":{"description":"The user's first name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Arthur","type":"string"},"ibm_uid":{"description":"The ID for the user. PUT User, Manager, Admin for self.","example":0,"type":"integer"},"last_name":{"description":"The user's last name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Lumra","type":"string"},"name":{"description":"The user first_name and last_name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Arthur Lumra","type":"string"},"organization_admin":{"description":"Whether or not this user has administrative privileges in the organization. PUT Admin permission required.","example":false,"type":"boolean"},"provisioned":{"description":"Whether or not the user's home folder is ready for use.","example":false,"type":"boolean"},"public_key":{"description":"Whether or not the user record for this user includes the user's public key. The user can add their public key to their record, or the organization administrator can add it. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":false,"type":"boolean"},"subscription_admin":{"description":"future feature PUT Admin permission required.","example":false,"type":"boolean"},"user_admin":{"description":"future feature PUT Admin permission required.","example":false,"type":"boolean"}},"required":["email"],"type":"object"},"users_response":{"properties":{"ats_admin":{"description":"Whether or not this user has ATS (Aspera Transfer Service) administrative permissions.","example":false,"type":"boolean"},"available_apps":{"description":"future feature","type":"string"},"created_at":{"description":"The timestamp for initial creation of this user. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"deactivated":{"description":"Whether or not this user is deactivated. A deactivated user cannot log in to Aspera on Cloud, but still exists in the user database.","example":false,"type":"boolean"},"default_shortlink_name":{"description":"When shortened links are enabled for a workspace, and this user has permission to send an invitation inviting another person to send them a package, this is the default configuration of the shortened link for this user. The default shortened link is comprised of 'first_name' and 'last_name' for this user.","example":"artik_lumra","type":"string"},"default_workspace_choice":{"description":"The workspace selected by the user as their default; when the user logs in to Aspera on Cloud, the default workspace displays. If the user has not selected a default workspace, the last used workspace displays.","example":"last_used","type":"string"},"default_workspace_id":{"description":"The ID of the user-selected default workspace. If the user has not selected a default workspace, the field contains the ID of the user's last used workspace.","example":0,"type":"string"},"email":{"description":"The email address associated with this user in the Aspera on Cloud user database. This is the user's login username.","example":"email@example.com","type":"string"},"first_name":{"description":"The user's first name.","example":"Arthur","type":"string"},"home_file_id":{"description":"The file ID of the user's root or home folder, which contains all files and folders the user uploads, along with links to folders shared with this user by the administrator or by other users.","example":0,"type":"integer"},"home_node_id":{"description":"The ID of the node containing the user's home folder.","example":0,"type":"integer"},"id":{"description":"The ID for the user.","example":0,"type":"integer"},"last_login_at":{"description":"The timestamp for the last time the user logged in. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"last_login_provider":{"description":"The authorization method used for the most recent login.","example":"saml","type":"string"},"last_name":{"description":"The user's last name.","example":"Bartlance","type":"string"},"member_of_any_workspace":{"description":"Whether or not the user has membership in any workspace. Refer to .","example":false,"type":"boolean"},"name":{"description":"The user first_name and last_name.","example":"Artik","type":"string"},"organization_admin":{"description":"Whether or not this user has administrative privileges in the organization.","example":false,"type":"boolean"},"organization_id":{"description":"ID of the AoC organization to which the client belongs.","example":4,"type":"integer"},"password_updated_at":{"description":"The timestamp for the most recent update to the user password. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"provisioned":{"description":"Whether or not the user's home folder is ready for use.","example":false,"type":"boolean"},"public_key":{"description":"Whether or not the user record for this user includes the user's public key. The user can add their public key to their record, or the organization administrator can add it.","example":false,"type":"boolean"},"read_only_home_file_id":{"description":"The file ID of the home folder for a user who may have access to some shared folders in the workspace, but is not a member of the workspace.","example":"873398","type":"string"},"read_only_home_node_id":{"description":"The ID of the node containing the user's read-only home folder.","example":3214,"type":"integer"},"running_operation_count":{"description":"The number of user-related operations currently in progress.","example":34,"type":"integer"},"saml_configuration_id":{"description":"The ID for this user in the SAML authentication login. If user is not a SAML user, set this parameter to null.","example":null,"type":"string"},"stopped_operation_count":{"description":"The number of user-related operations that are stopped for any reason.","example":12,"type":"integer"},"subscription_admin":{"description":"future feature","example":false,"type":"boolean"},"trial":{"description":"Whether or not this org/user is a trial","example":false,"type":"boolean"},"updated_at":{"description":"The timestamp for when the user record was most recently updated. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"user_admin":{"description":"future feature","example":false,"type":"boolean"}},"type":"object"},"workspace_filter_params":{"properties":{"created_at":{"format":"date-time","type":"string"},"manager":{"type":"boolean"},"name":{"type":"string"},"node_id":{"type":"integer"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"workspace_memberships_params":{"properties":{"can_invite_by_email":{"description":"Whether or not inviting users to this workspace by email is allowed.","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"member_id":{"description":"The ID of the member","example":0,"type":"integer"},"member_type":{"description":"The member type.","example":"user","type":"string"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"},"workspace_id":{"description":"The ID of the workspace in which to grant this membership.","example":0,"type":"integer"}},"required":["member_id","member_type","workspace_id"],"type":"object"},"workspace_memberships_response":{"properties":{"id":{"description":"Membership ID.","example":0,"type":"string"},"inherited":{"description":"The membership in this workspace is 'inherited'. The user is not a direct member, but rather a member by means of being a member of a group that is a member of the workspace.","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"member_id":{"description":"The ID of the member.","example":0,"type":"integer"},"member_type":{"description":"The user type for this member. Valid values- user, group.","example":"user","type":"string"},"running_operation_count":{"description":"The number of workspace-membership-related operations currently in progress.","example":0,"type":"integer"},"stopped_operation_count":{"description":"The number of workspace-membership-related operations that are stopped for any reason.","example":0,"type":"integer"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"},"workspace_id":{"description":"The ID of the workspace.","example":0,"type":"integer"}},"type":"object"},"workspace_memberships_update_params":{"properties":{"can_invite_by_email":{"description":"Whether or not inviting users to this workspace by email is allowed.\n","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"}},"type":"object"},"workspace_query_params":{"properties":{"created_at":{"format":"date-time","type":"string"},"manager":{"type":"boolean"},"name":{"description":"full text search","type":"string"},"node_id":{"type":"integer"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"workspaces_params":{"properties":{"allow_package_level_expirations":{"description":"Allow senders to set package expiration when sending. If workspace settings are configured by the admin, senders can only further restrict the workspace setting. Refer to delete_package_content_after_download_duration and to content_retention_duration. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_settings_editable_by_managers":{"description":"Allow workspace manager to configure workspace collaboration settings. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_whitelist_enabled":{"description":"If collaboration with users outside the workspace is enabled (external_package_sending_allowed=true and/or external_sharing_allowed=true), enable a whitelist of external users who can be recipients of packages and/or shared folders. To configure the whitelist, POST or PUT to /workspace_collaborators. POST: Admin permission required. PUT: Manager with collaboration settings edit permission or Admin permission required. settings editable by managers required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_with_emails_allowed":{"description":"If external_package_sending_allowed(_by_managers) and/or external_sharing_allowed(_by_managers) is/are set to true, setting this parameter to true allows those who are allowed to send to or share with external users (all users or workspace managers only) to see email addresses of external users in the list of contacts displayed in the (1) recipients field of the package sending form, and/or (2) the recipients field of the folder sharing form. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on time. To set a download-based expiration policy, refer to delete_package_content_after_download_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"default_ear_setting":{"description":"When this parameter is set to true, encryption-at-rest is mandatory for all packages sent in this workspace. Senders must set a passphrase for every package they send, then must deliver the passphrase to the recipient according to local site security practice. Only when the recipient applies that passphrase can the package be decrypted. When this parameter is set to true, the parameter of the /packages endpoint that corresponds to EAR is always set to true and cannot be edited. When this parameter is set to false, the field in the /packages endpoint can be set to true or false, giving the sender the choice whether to apply EAR to a given package or not. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on whether or not recipients have downloaded the package. To set a time-based expiration policy, refer to content_retention_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"description":{"description":"A description for the workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).","example":"Maximum characters: 65535","type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this workspace by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If null, contents of draft packages in this workspace are not deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer to content_retention_duration. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"email_footer":{"description":"If 'inherit_email_templates' is set to false, configure the footer for email notifications for this workspace. The footer you configure is common to all email notifications for this workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notification specification. See below. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE Admin scope (org admin).","type":"object"},"enable_external_email_templates":{"description":"If 'inherit_email_templates' is set to false, you can enable or disable the ability to configure email templates specifically for users outside this workspace. When this parameter is set to false, external recipients receive the same email notification messages that users in the workspace receive. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"enable_external_notifications":{"description":"Not used.","example":true,"type":"boolean"},"event_reporting_headers":{"description":"If event_reporting_uri is configured, users can submit JSON of all acceptable headers. If event_reporting_uri is not configured, this parameter does not apply. POST: Admin permission required. Maximum characters: 65535.","example":"","type":"string"},"event_reporting_uri":{"description":"The URI to collect event and activity reports. If this parameter is not null, you can use the event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"external_package_authentication_required":{"description":"Require external recipients of packages sent from this workspace to authenticate before they can access the package. POST: Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"external_package_sending_allowed":{"description":"Allow members of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_package_sending_allowed_by_managers":{"description":"Allow workspace managers of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have a Files account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_sharing_allowed":{"description":"Allow members of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"external_sharing_allowed_by_managers":{"description":"Allow workspace managers of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"home_container_file_id":{"description":"The file ID of the folder containing users' home folders for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"5","type":"string"},"image_data":{"description":"The image data encoded as a string. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope if params[:include]=true. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the workspace logo; for example, image/png or image/jpg. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"image/png","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the organization. If set to false, you can configure external email notification settings for this workspace; see 'enable_external_notifications'. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Whether or not to inherit the email templates configured at the organization. If set to true, the workspace inherits the settings configured at the organization level. If set to false, you can configure email template settings for this workspace; see 'enable_external_email_templates' and other email notification settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_external_notifications":{"description":"Whether or not the workspace inherits external notifications. PUT Admin permission required.","example":false,"type":"boolean"},"invitations_allowed":{"description":"Allow members of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"invitations_allowed_by_managers":{"description":"Allow workspace managers of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"name":{"description":"The workspace name. Query parameter for GET method. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"My New Workspace","type":"string"},"node_id":{"description":"The ID of the node on which workspace folders and packages are stored. Query parameter for GET method. POST Admin permission required. PUT Manager permission required.","example":14,"type":"integer"},"package_download_counts_enabled":{"description":"Whether or not package download counts are recorded. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"personalized_urls_enabled":{"description":"Enable members of this workspace to configure personalized URLs to send when inviting people to submit packages (refer to public_links_allowed). You can set this parameter to true only if url_shortening_enabled is also set to true. Once you enable personalized URLs, you enable a default personalized URL construction and you also allow workspace member to configure the URLs they send. The default URL configuration contains the sender's username or the dropbox name; for example: https://aspera.pub/John_Doe;https://aspera.pub/Dropbox1. Note that dropboxes in the workspace inherit the settings you configure for the workspace as follows: When short URLs are enabled at the workspace (url_shortening_enabled=true): Short URLs are enabled for all dropboxes in that workspace. You cannot disable short URLs for a dropbox. When personalized URLs are enabled at the workspace: Personalized URLs are enabled for all dropboxes in that workspace. You can disable personalized URLs for specific dropboxes if desired. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":false,"type":"boolean"},"public_invites_allowed":{"description":"Allow workspace members to send invitations to users outside the workspace, inviting them to send a package to (1) the user who issues the invitation, and (2) the dropboxes in which the user who issues the invitation is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"public_invites_allowed_by_managers":{"description":"Allow workspace managers to send invitations to users outside the workspace, inviting them to send a package to (1) the workspace manager who issues the invitation, and (2) the dropboxes in which the workspace manager is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed":{"description":"Allow users in the workspace to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed_by_managers":{"description":"Allow workspace managers to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"root_file_id":{"description":"The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"spool_file_id":{"description":"Where packages are stored POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"4","type":"string"},"storage_allowed":{"description":"Whether or not the users of this workspace can upload to their respective home folders. Set this parameter to false to prevent users from uploading to or creating new folders in their home folders. Restricting these functions is one way to control storage usage in the workspace. To exempt certain workspace members from this restriction, set storage_allowed to true for those members in /workspace_memberships. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"url_shortening_enabled":{"description":"When members of this workspace send a link that allows the recipeint to send a package (refer to public_invites_allowed), the link generated will have the shortened form; for example: (compared to the standard URL; for example: ). When this parameter is set to true, you can also set personalized_urls_enabled to true. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"}},"required":["name","node_id"],"type":"object"},"workspaces_response":{"properties":{"allow_package_level_expirations":{"description":"Allow senders to set package expiration when sending. If workspace settings are configured by the admin, senders can only further restrict the workspace setting. Refer to delete_package_content_after_download_duration and to content_retention_duration. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"can_invite_by_email":{"description":"RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"collaboration_settings_editable_by_managers":{"description":"Allow workspace manager to configure workspace collaboration settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_whitelist_enabled":{"description":"If collaboration with users outside the workspace is enabled (external_package_sending_allowed=true and/or external_sharing_allowed=true), enable a whitelist of external users who can be recipients of packages and/or shared folders. To configure the whitelist, POST or PUT to /workspace_collaborators. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_with_emails_allowed":{"description":"If external_package_sending_allowed(_by_managers) and/or external_sharing_allowed(_by_managers) is/are set to true, setting this parameter to true allows those who are allowed to send to or share with external users (all users or workspace managers only) to see email addresses of external users in the list of contacts displayed in the (1) recipients field of the package sending form, and/or (2) the recipients field of the folder sharing form. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once the transfer complete, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on time. To set a download-based expiration policy, refer to delete_package_content_after_download_duration. Valid values (null - 10 years) Units (seconds) POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"created_at":{"description":"datetime RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"2018-02-16T04:30:58Z","format":"date-time","type":"string"},"default_ear_setting":{"description":"When this parameter is set to true, encryption-at-rest is mandatory for all packages sent in this workspace. Senders must set a passphrase for every package they send, then must deliver the passphrase to the recipient according to local site security practice. Only when the recipient applies that passphrase can the package be decrypted. When this parameter is set to true, the parameter of the /packages endpoint that corresponds to EAR is always set to true and cannot be edited. When this parameter is set to false, the field in the /packages endpoint can be set to true or false, giving the sender the choice whether to apply EAR to a given package or not. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on whether or not recipients have downloaded the package. To set a time-based expiration policy, refer to content_retention_duration. Valid values (null - 10 years) Units (seconds) POST Admin permission required. PUT Manager permission required. or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"description":{"description":"A description for the workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"Maximum characters: 65535","type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this workspace by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If null, contents of draft packages in this workspace are not deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer to content_retention_duration. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"effective_default_ear_setting":{"description":"RESPONSE User scope. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"effective_storage_allowed":{"description":"RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"email_footer":{"description":"If 'inherit_email_templates' is set to false, configure the footer for email notifications for this workspace. The footer you configure is common to all email notifications for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notification specification. See below. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","type":"object"},"enable_external_email_templates":{"description":"If 'inherit_email_templates' is set to false, you can enable or disable the ability to configure email templates specifically for users outside this workspace. When this parameter is set to false, external recipients receive the same email notification messages that users in the workspace receive. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"enable_external_notifications":{"description":"Not used. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"event_reporting_headers":{"description":"If event_reporting_uri is configured, users can submit JSON of all acceptable headers. If event_reporting_uri is not configured, this parameter does not apply. POST Admin permission required.","example":"Maximum characters: 65535","type":"string"},"event_reporting_uri":{"description":"The URI to collect event and activity reports. If this parameter is not null, you can use the event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"external_package_authentication_required":{"description":"Require external recipients of packages sent from this workspace to authenticate before they can access the package. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"external_package_sending_allowed":{"description":"Allow members of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_package_sending_allowed_by_managers":{"description":"Allow workspace managers of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_sharing_allowed":{"description":"Allow members of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"external_sharing_allowed_by_managers":{"description":"Allow workspace managers of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"group_id":{"description":"The ID of the group containing all members of this workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":4,"type":"integer"},"home_container_file_id":{"description":"The file ID of the folder containing users' home folders for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"5","type":"string"},"home_file_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"},"home_node_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"},"id":{"description":"The ID of the workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"3","type":"string"},"image_data":{"description":"The image data encoded as a string. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope if params[:include]=true. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the workspace logo; for example, image/png or image/jpg. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"image/png","type":"string"},"image_url":{"description":"The URL of the image. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"https://api.asperafiles.com/api/v1/user_images/32850?oh=cg-nf7pFnNK0-N3g3r-f2nRg","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the organization. If set to false, you can configure external email notification settings for this workspace; see 'enable_external_notifications'. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Whether or not to inherit the email templates configured at the organization. If set to true, the workspace inherits the settings configured at the organization level. If set to false, you can configure email template settings for this workspace; see 'enable_external_email_templates' and other email notification settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_external_notifications":{"description":"Whether or not the workspace inherits external notifications. PUT Admin permission required.","example":false,"type":"boolean"},"invitations_allowed":{"description":"Allow members of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"invitations_allowed_by_managers":{"description":"Allow workspace managers of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type. RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"managers_group_id":{"description":"The ID of the group containing all manager of this workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":0,"type":"integer"},"member":{"description":"The user is part of the workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"name":{"description":"The workspace name. Query parameter for GET method. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"My New Workspace","type":"string"},"node_id":{"description":"The ID of the node on which workspace folders and packages are stored. Query parameter for GET method. POST Admin permission required. PUT Manager permission required.","example":14,"type":"integer"},"package_download_counts_enabled":{"description":"Whether or not package download counts are recorded. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"personalized_urls_enabled":{"description":"Enable members of this workspace to configure personalized URLs to send when inviting people to submit packages (refer to public_links_allowed). You can set this parameter to true only if url_shortening_enabled is also set to true. Once you enable personalized URLs, you enable a default personalized URL construction and you also allow workspace member to configure the URLs they send. The default URL configuration contains the sender's username or the dropbox name; for example: https://aspera.pub/John_Doe;https://aspera.pub/Dropbox1. Note that dropboxes in the workspace inherit the settings you configure for the workspace as follows: When short URLs are enabled at the workspace (url_shortening_enabled=true): Short URLs are enabled for all dropboxes in that workspace. You cannot disable short URLs for a dropbox. When personalized URLs are enabled at the workspace: Personalized URLs are enabled for all dropboxes in that workspace. You can disable personalized URLs for specific dropboxes if desired. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":false,"type":"boolean"},"public_invites_allowed":{"description":"Allow workspace members to send invitations to users outside the workspace, inviting them to send a package to (1) the user who issues the invitation, and (2) the dropboxes in which the user who issues the invitation is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"public_invites_allowed_by_managers":{"description":"Allow workspace managers to send invitations to users outside the workspace, inviting them to send a package to (1) the workspace manager who issues the invitation, and (2) the dropboxes in which the workspace manager is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed":{"description":"Allow users in the workspace to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed_by_managers":{"description":"Allow workspace managers to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"root_file_id":{"description":"The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"spool_file_id":{"description":"Where packages are stored POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"4","type":"string"},"storage_allowed":{"description":"Whether or not the users of this workspace can upload to their respective home folders. Set this parameter to false to prevent users from uploading to or creating new folders in their home folders. Restricting these functions is one way to control storage usage in the workspace. To exempt certain workspace members from this restriction, set storage_allowed to true for those members in /workspace_memberships. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"updated_at":{"description":"datetime RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"2018-02-16T04:30:58Z","format":"date-time","type":"string"},"url_shortening_enabled":{"description":"When members of this workspace send a link that allows the recipient to send a package (refer to public_invites_allowed), the link generated will have the shortened form; for example: (compared to the standard URL; for example: ). When this parameter is set to true, you can also set personalized_urls_enabled to true. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"user_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"}},"type":"object"}},"securitySchemes":{"HTTP_Basic":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"x-ibm-configuration":{"enforced":false,"testable":true,"phase":"realized","cors":{"enabled":true}}} \ No newline at end of file +{"openapi":"3.0.0","info":{"description":"API for Aspera File Management","version":"0.2.7","title":"Files API","x-ibm-name":"files-api_latest","contact":{"name":"Carole Baden","email":"cbaden@us.ibm.com"}},"servers":[{"url":"https://api.ibmaspera.com/"}],"tags":[{"description":"Use /clients to register your client application with the Files API. You can also modify your client, retrieve a list of all registered clients or a specific client, or delete a specific client. You can configure your client to use browser-based authentication or JSON web token (JWT) authentication. For clients using JWT authentication, this endpoint relates to /client_authorizations.","name":"/clients"},{"description":"When you use the JWT authentication method for your client (see /clients) and enable a whitelist of authorized users or groups, you must configure which users or groups can access the API using your client, and which type of key each user can submit to retrieve an access token–either a user-specific key or a global key. Use the /client_authorizations endpoint to configure the authorized users or groups; use the /users endpoint to configure the user key types; use the /clients endpoint to configure the global key. There are two configuration parameters for users and keys. Users: All users: All users in the AoC organization are eligible to retrieve an access token; Only listed users: Only the users or groups you list are eligible to receive an access token. Keys: User-specific keys: The JWT must be signed with the specified user's own private key; User-specific keys and global key: The JWT can be signed with the specified user's own private key or with the global private key. Note: Any user accessing the AoC API using the JWT method must have their public key listed in their AoC user record. The user can enter their own public key, or the AoC administrator can enter the user's public key in the individual user's record. Important! API clients with a global key can retrieve access tokens for and act as any listed user. Use global keys according to local site security practice.","name":"/client_authorizations"},{"description":"Create a workspace (requires an admin token). The workspace is a distinct context in which workspace members can freely share files and send packages. All workspace users of the same type (for example, members or workspace managers) share collaboration settings for that user type. A workspace is a folder on a specific node; the workspace storage is separate from the storage of other workspaces. The workspace contains member users and groups. A workspace may have a workspace manager, who is also a workspace member, that can perform certain administrative function for that specific workspace. (Configure workspace manager using /workspace_memberships).","name":"/workspaces"},{"description":"Use this endpoint to add existing users as members of a workspace, and to update, retrieve, and delete workspace members. An Aspera on Cloud user can be a direct member of a workspace, or can inherit membership by being a member of a user group that is a member of the workspace. This endpoint allows you to add a user or group as a direct member of a workspace. You can also use this endpoint to grant or revoke workspace manager permission to a member (user or group).","name":"/workspace_memberships"},{"description":"A package is a bundle of files and folders (like a ZIP file or TAR file) specified by an AoC user to send to designated recipients. Packages can be sent to individuals, to groups (including to a workspace), or to shared inboxes. Packages can be sent, received, recalled, archived, deleted. Sending a package can be completed with a user token or with an admin token. The process of sending a package comprises multiple steps. You use the POST, GET, and PUT methods of /packages, along with requests to the Connect API or the Node API. The folder structure of a package on disk is as follows: {id}.asp-package contains metadata and other package-related files and contains contents, which contains the files and folders in the package. Uploads of package contents should go directly into the named, innermost folder. Downloads of the entire package should be of the named, outermost folder (renamed on download to the package name itself). To get package transfers to properly register, they should be tagged as follows: {\"aspera\": {\"files\": {\"package_id\" : the-package-id}}}.","name":"/packages"},{"description":"A user is anybody using this service. Users may be organization administrators, workspace managers, photographers, IT, etc. Users are identified by email address, so 'email' is a required property when creating a new user.","name":"/users"},{"name":"/nodes","description":"The Nodes resource contains the information that a client app can use to communicate directly with an Aspera transfer server (which has files and folders).\n"},{"description":"A shared inbox (formerly called a dropbox) serves three functions. First, it acts as a place where users can submit content. Second, it notifies its members when new content arrives. Finally, it can ask users who submit new content to fill out a form using a metadata schema.\n","name":"/dropboxes"},{"description":"Use this endpoint to add existing members to a dropbox and to update, retrieve, and delete existing dropbox members. An Aspera on Cloud user can be a direct member of a dropbox or they can inherit membership through a user group.\n","name":"/dropbox_memberships"},{"name":"/usage_reports","description":"When enabled, usage reporting collects information about the number of bytes transferred into and out of an organization, on a per-workspace or per-access key basis. A report begins at the start of a month (or when usage reporting is enabled) and ends at the beginning of the next month, when a new report is created. An active report for the current month shows month-to-date usage information, while usage reports for previous months no longer change and show historical data. Due to the way the reporting information is collected, the number of bytes transferred is an approximation and may vary from the actual billed usage if there are transfers that are close to or spanning the changeover between months. NOTE: Usage reports are read-only resources and all attributes are read-only.\n"},{"name":"/organizations","description":"An organization contains all the users, groups, and resources belonging to a real-world organization. Users within an organization can see only the organization they are in. Organization admins can change certain properties of the organization. All other users within the organization have read-only access. Note: /organization is an alias to /organizations/{current user's organization id}.\n"},{"description":"This endpoint is used to manage existing transfer node access keys. Specifically, it streamlines the task of viewing all access keys across all transfer nodes that belong to your organization. Note that this endpoint is not capable of creating or destroying transfer node access keys (that is handled via the Node API). Organization admin or workspace manager permissions are required for any access to this endpoint.\n","name":"/client_access_keys"},{"description":"The /apps/app_memberships endpoint is useful for organization admins that want to enable users to access the Automation or Activity apps. Additionally, this endpoint is useful for admins who want to view all app memberships across their entire organization, or for any other user to view their own app memberships.\n","name":"/apps/app_memberships"}],"paths":{"/apps/app_memberships":{"get":{"parameters":[{"description":"Can be \"activity\" or \"automation\".","in":"query","name":"aspera_app_type","schema":{"type":"string"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"description":"Set to false if you want to filter out inherited memberships.\n","in":"query","name":"inherited","schema":{"type":"boolean"}},{"in":"query","name":"last_login_at","schema":{"format":"date-time","type":"string"}},{"description":"For member_type=user.","in":"query","name":"member.email","schema":{"type":"string"}},{"description":"For member_type=user.","in":"query","name":"member.name","schema":{"type":"string"}},{"description":"Can be \"user\" or \"group\".","in":"query","name":"member_type","schema":{"type":"string"}},{"description":"Searches member.email and member.name.","in":"query","name":"q","schema":{"type":"string"}},{"description":"Specify a field for sorting results.","in":"query","name":"sort","schema":{"type":"string"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/app_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Get a listing of app memberships. For organization admins, all app memberships for the entire organization are available to view. For all other users, your own app memberships are available.\n","operationId":"get_app_memberships","summary":"Get a Listing of App Memberships"}},"/apps/app_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Delete an app membership, specified by membership ID. Requires organization admin permission.\n","operationId":"delete_app_membership","summary":"Delete a Specific App Membership"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Get information about a specific app membership, specified by membership ID.\n","operationId":"get_app_membership_by_id","summary":"Get Information About a Specific App Membership"}},"/apps/{aspera_app_type}/app_memberships":{"post":{"parameters":[{"in":"path","name":"aspera_app_type","required":true,"schema":{"enum":["activity","automation"],"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/apps/app_memberships"],"description":"Create an app membership. Requires organization admin permission.\n","operationId":"add_app_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_memberships_params"}}},"required":true},"summary":"Create a New App Membership"}},"/client_access_keys":{"get":{"parameters":[{"in":"query","name":"node_id","schema":{"type":"string"}},{"in":"query","name":"root_file_id","schema":{"type":"string"}},{"in":"query","name":"permission_id","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/client_access_keys_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Get a listing of client access keys for your organization.","operationId":"get_client_access_keys","summary":"Get a Listing of Client Access Keys"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Create a client access key.","operationId":"add_client_access_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_params"}}},"required":true},"summary":"Register a New Client Access Key with Aspera on Cloud"}},"/client_access_keys/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Delete a client access key, specified by ID.","operationId":"delete_client_access_key","summary":"Delete a Specific Client Access Key"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_access_keys_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Get information about a specific client access key, specified by ID.\n","operationId":"get_client_access_key_by_id","summary":"Get Information About a Specific Client Access Key"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_access_keys"],"description":"Update the name of a client access key.","operationId":"update_client_access_key","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"The name of the client access key.","example":"MyAccessKey","type":"string"}},"type":"object"}}},"required":true},"summary":"Update the Name of a Client Access Key"}},"/client_authorizations":{"get":{"parameters":[{"in":"query","name":"client_id","schema":{"type":"string"}},{"in":"query","name":"entity_id","schema":{"type":"string"}},{"in":"query","name":"entity_type","schema":{"type":"string"}},{"description":"embed[]=entity (gives back entity which should be user/group)","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/client_authorizations_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Get a listing of information on all client whitelists.","operationId":"get_client_authorizations","summary":"Get a Listing of Information on all Client Whitelists"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Create an authorization for an API client. Each entity to authorize requires a separate request.","operationId":"add_client_authorization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_params"}}},"required":true},"summary":"Create a New Authorization"}},"/client_authorizations/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Delete a user from a client whitelist.","operationId":"delete_client_authorization","summary":"Delete a User from a Client Whitelist"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=entity (gives back entity which should be user/group)","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_authorizations_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/client_authorizations"],"description":"Retrieve a listing with information on all entities in the whitelist for a specific client.","operationId":"get_client_authorization_by_id","summary":"Get Information on Entities in a Whitelist for a Specific Client"}},"/clients":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/clients_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Get a listing of clients currently registered to use the Aspera on Cloud API.","operationId":"get_clients","summary":"Get a Listing of All Registered Clients"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Create an API client.","operationId":"add_client","requestBody":{"$ref":"#/components/requestBodies/clients_params"},"summary":"Register a New Client with the Files API"}},"/clients/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Delete a registered client, specified by client ID.","operationId":"delete_client","summary":"Delete a Specific Registered Client"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Get information about a specific registered client, specified by the client ID returned in the GET response.","operationId":"get_client_by_id","summary":"Get Information about a Specific Registered Client"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/clients"],"description":"Update a registered client. For example, change the redirect URI and the admin node token retrieval parameters.","operationId":"update_client","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_params"}}},"required":true},"summary":"Modify a Registered Client"}},"/dropbox_memberships":{"get":{"parameters":[{"in":"query","name":"can_invite_submitters","schema":{"type":"boolean"}},{"in":"query","name":"can_receive_packages","schema":{"type":"boolean"}},{"in":"query","name":"can_submit_packages","schema":{"type":"boolean"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"creator_id","schema":{"type":"string"}},{"description":"Filters memberships with member_type = \"user\" by their \"deactivated\" attribute.\n","in":"query","name":"deactivated","schema":{"type":"boolean"}},{"in":"query","name":"dropbox_id","schema":{"type":"string"}},{"description":"embed%5B%5D=member (user or group object from member_id), embed%5B%5D=dropbox (dropbox object from dropbox_id)\n","in":"query","name":"embed%5B%5D","schema":{"type":"string"}},{"description":"Specifies whether or not to include inherited memberships in the response. Typically used when an admin is looking at the memberships for a particular member_id or when a user is looking at their own memberships.\n","in":"query","name":"inherited","schema":{"type":"boolean"}},{"in":"query","name":"manager","schema":{"type":"boolean"}},{"in":"query","name":"member.email","schema":{"type":"string"}},{"in":"query","name":"member.last_login_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"member.last_name","schema":{"type":"string"}},{"in":"query","name":"member.system_group","schema":{"type":"boolean"}},{"in":"query","name":"member_id","schema":{"type":"string"}},{"description":"Either \"user\" or \"group\"","in":"query","name":"member_type","schema":{"type":"string"}},{"description":"Search member.email, member.first_name, member.last_name, and member.name.\n","in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/dropbox_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Get a listing of information about the current members of a given dropbox.\n","operationId":"get_dropbox_memberships","summary":"Get a Listing of All Dropbox Members"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_params"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Add a user or group as a member of this dropbox.","operationId":"add_dropbox_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_params"}}},"required":true},"summary":"Add a Dropbox Member"}},"/dropbox_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Remove a direct dropbox membership. Note: If the user also has indirect membership through a group, the user will still have access to the dropbox.\n","operationId":"delete_dropbox_membership","summary":"Remove a Member from a Dropbox"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed%5B%5D=member (member object from member_id), embed%5B%5D=dropbox (dropbox object from dropbox_id)\n","in":"query","name":"embed%5B%5D","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Get information on a specific dropbox membership.","operationId":"get_dropbox_membership_by_id","summary":"Get Information on a Specific Dropbox Membership"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropbox_memberships"],"description":"Update an existing dropbox membership.","operationId":"update_dropbox_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropbox_memberships_update_params"}}},"required":true},"summary":"Update a Dropbox Membership"}},"/dropboxes":{"get":{"parameters":[{"description":"Time at which the shared inbox was created.","in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"description":"Time at which the shared inbox was last updated.","in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"description":"Searches across shared inbox descriptions and names.","in":"query","name":"q","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/dropboxes_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Retrieve a listing of all shared inboxes.","operationId":"get_dropboxes","summary":"Get a Listing of All Shared Inboxes"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Create a new shared inbox.","operationId":"add_dropbox","requestBody":{"$ref":"#/components/requestBodies/dropboxes_params"},"summary":"Create a New Shared Inbox"}},"/dropboxes/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Delete a specific shared inbox, specified by shared inbox ID.","operationId":"delete_dropbox","summary":"Delete a Specific Shared Inbox"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Retrieve information on a specific shared inbox.","operationId":"get_dropbox_by_id","summary":"Get Information on a Specific Shared Inbox"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/dropboxes"],"description":"Make changes to an existing shared inbox.","operationId":"update_dropbox","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_params"}}},"required":true},"summary":"Update a Shared Inbox"}},"/nodes":{"get":{"parameters":[{"in":"query","name":"access_key","schema":{"type":"string"}},{"in":"query","name":"host","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"path","schema":{"type":"string"}},{"in":"query","name":"port","schema":{"type":"string"}},{"description":"Full text search that will show transfer nodes with matching access_key, host, name, path, or port.","in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/nodes_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Get information about all transfer nodes belonging to your organization.","operationId":"get_nodes","summary":"Get a Listing of All Nodes"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Create a new transfer node. User must be an organization admin.","operationId":"add_node","requestBody":{"$ref":"#/components/requestBodies/nodes_params"},"summary":"Create a New Node"}},"/nodes/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Delete a specific transfer node, as specified by node ID. User must be an organization admin.","operationId":"delete_node","summary":"Delete a Specific Node"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Retrieve information about a specific transfer node.","operationId":"get_node_by_id","summary":"Get Information on a Specific Node"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/nodes"],"description":"Make changes to an existing transfer node. User must be an organization admin.","operationId":"update_node","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_params"}}},"required":true},"summary":"Update a Node"}},"/organizations/{id}":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"tags":["/organizations"],"description":"Retrieve information about your organization.","operationId":"get_organization","summary":"Get Information About Your Organization"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/organizations"],"description":"Make changes to your organization. Must be an organization admin to access.\n","operationId":"update_organization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_params"}}},"required":true},"summary":"Update Your Organization"}},"/packages":{"get":{"parameters":[{"in":"query","name":"complete","schema":{"type":"boolean"}},{"in":"query","name":"completed","schema":{"type":"boolean"}},{"in":"query","name":"completed_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deleted","schema":{"type":"boolean"}},{"in":"query","name":"dropbox_id","schema":{"type":"string"}},{"in":"query","name":"expired","schema":{"type":"boolean"}},{"in":"query","name":"failed","schema":{"type":"boolean"}},{"in":"query","name":"draft","schema":{"type":"boolean"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"sent_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deleted_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"size","schema":{"type":"integer"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}},{"in":"query","name":"sender_email","schema":{"type":"string"}},{"in":"query","name":"sender_id","schema":{"type":"string"}},{"in":"query","name":"sender_name","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"archived","schema":{"type":"boolean"}},{"in":"query","name":"read","schema":{"type":"boolean"}},{"in":"query","name":"received","schema":{"type":"boolean"}},{"in":"query","name":"sent","schema":{"type":"boolean"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"include_draft","schema":{"type":"boolean"}},{"in":"query","name":"exclude_dropbox_packages","schema":{"type":"boolean"}},{"in":"query","name":"has_content","schema":{"type":"boolean"}},{"description":"embed[]=node (node from node_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/packages_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Get information about all packages or retrieve packages sent to me in a specific workspace, sent to me as individual (not as a member of a dropbox), that are not archived and not deleted if the user ID is included in the token sent with the call.","operationId":"get_packages","summary":"Get a Listing of All Packages"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Recipient can be an individual user, workspace, or a dropbox.","operationId":"add_package","requestBody":{"$ref":"#/components/requestBodies/packages_params"},"summary":"Create Package to Send"}},"/packages/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Use package_id to delete the contents of a specific package. This action removes package contents permanently, but retains information on the package: sender, recipients, size, date, metadata if any, download history, and transfer specs like rate.","operationId":"delete_package","summary":"Delete a Specific Package"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=node (node from node_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Get information on a specific package.","operationId":"get_package_by_id","summary":"Get Information on a Specific Package"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/packages"],"description":"Use the PUT method to mark the package \"sent=true\", including the proper number of transfers in the \"transfers_expected\" field, after the transfers have completed. The number of transfers expected depends on the number of discrete source locations of package contents.","operationId":"update_package","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_params"}}},"required":true},"summary":"Update a package"}},"/usage_reports":{"get":{"parameters":[{"in":"query","name":"node_id","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"string"}},{"in":"query","name":"reporting_period_started_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"reporting_period_ended_at","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/usage_reports_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["/usage_reports"],"description":"Get a listing of usage reports.","operationId":"get_usage_reports","summary":"Get a Listing of Usage Reports"}},"/users":{"get":{"parameters":[{"in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"deactivated","schema":{"type":"boolean"}},{"in":"query","name":"email","schema":{"type":"string"}},{"in":"query","name":"first_name","schema":{"type":"string"}},{"in":"query","name":"last_login_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"last_name","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"organization_admin","schema":{"type":"boolean"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"description":"embed[]=home_node embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/users_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Get a list of information about all users.","operationId":"get_users","summary":"Get a Listing of Users"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Create a new user.","operationId":"add_user","requestBody":{"$ref":"#/components/requestBodies/users_params"},"summary":"Create a New User"}},"/users/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Delete a specific user.","operationId":"delete_user","summary":"Delete a Specific User"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=home_node embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Get Information on a specific user.","operationId":"get_user_by_id","summary":"Get Information on a Specific User"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/users"],"description":"Make a change to an existing user; for example, make a user an administrator.","operationId":"update_user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_params"}}},"required":true},"summary":"Update a Specific User Record"}},"/workspace_memberships":{"get":{"parameters":[{"in":"query","name":"can_invite_by_email","schema":{"type":"boolean"}},{"in":"query","name":"manager","schema":{"type":"string"}},{"in":"query","name":"workspace_id","schema":{"type":"integer"}},{"in":"query","name":"storage_allowed","schema":{"type":"boolean"}},{"description":"embed[]=user (user object from user_id) embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/workspace_memberships_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Get information about the current members of a given workspace.","operationId":"get_workspace_memberships","summary":"Get a Listing of All Workspace Members"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Add a user as a member of this workspace.","operationId":"add_workspace_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_params"}}},"required":true},"summary":"Add a User as a Workspace Member"}},"/workspace_memberships/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Remove a direct workspace membership. Note: If the user has indirect membership, through a group for example, the user still has access to the workspace.","operationId":"delete_workspace_membership","summary":"Remove a Member from a Workspace"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=user (user object from user_id) embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=workspace","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Get information on a specific membership.","operationId":"get_workspace_membership_by_id","summary":"Get Information on a Specific Membership"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspace_memberships"],"description":"Make an existing workspace member a workspace manager.","operationId":"update_workspace_membership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_memberships_update_params"}}},"required":true},"summary":"Update a Workspace Membership"}},"/workspaces":{"get":{"parameters":[{"description":"datetime","in":"query","name":"created_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"node_id","schema":{"type":"integer"}},{"in":"query","name":"updated_at","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"manager","schema":{"type":"boolean"}},{"description":"embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/workspaces_response"},"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Retrieve a listing of all configured workspaces.","operationId":"get_workspaces","summary":"Get a Listing of All Workspaces"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_response"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Create a new workspace.","operationId":"add_workspace","requestBody":{"$ref":"#/components/requestBodies/workspaces_params"},"summary":"Create a New Workspace"}},"/workspaces/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Delete a specific workspace, specified by workspace ID.","operationId":"delete_workspace","summary":"Delete a specific Workspace"},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"embed[]=node (node from node_id) embed[]=group (from group_id) embed[]=organization","in":"query","name":"embed[]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_response"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Retrieve information on a specific workspace.","operationId":"get_workspace_by_id","summary":"Get Information on a Specific Workspace"},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"tags":["/workspaces"],"description":"Make changes to an existing workspace; for example, change collaboration settings.","operationId":"update_workspace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_params"}}},"required":true},"summary":"Update a Workspace"}}},"components":{"requestBodies":{"clients_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clients_params"}}},"required":true},"dropboxes_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dropboxes_params"}}},"required":true},"nodes_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nodes_params"}}},"required":true},"packages_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/packages_params"}}},"required":true},"users_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_params"}}},"required":true},"workspaces_params":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaces_params"}}},"required":true}},"schemas":{"app_memberships_params":{"properties":{"member_id":{"description":"The ID of the member that this membership belongs to.","example":"27","type":"string"},"member_type":{"description":"The type of member that this membership belongs to.","enum":["user","group"],"example":"user","type":"string"}},"type":"object"},"app_memberships_response":{"properties":{"app_name":{"description":"Name of the app that the membership belongs to.","example":"Activity","type":"string"},"app_type":{"description":"Type of app that the membership belongs to.","enum":["activity","automation"],"example":"activity","type":"string"},"id":{"description":"ID of the app membership.","example":"372","type":"string"},"member_id":{"example":"213","type":"string"},"member_type":{"enum":["user","group"],"example":"user","type":"string"}},"type":"object"},"client_access_keys_params":{"properties":{"id":{"description":"ID of the client access key.","example":"999","type":"string"},"name":{"description":"Name of the client access key.","example":"MyAccessKey","type":"string"},"node_id":{"description":"ID of the transfer node that the client access key belongs to.","example":"42","type":"string"},"permission_id":{"example":null,"type":"string"},"root_file_id":{"description":"ID of the directory that this access key grants permissions for.\n","example":"bar","type":"string"}},"required":["id","root_file_id","node_id"],"type":"object"},"client_access_keys_response":{"properties":{"created_at":{"description":"Date at which the client access key was created.","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"id":{"description":"ID of the client access key.","example":"999","type":"string"},"name":{"description":"Name of the client access key.","example":"MyAccessKey","type":"string"},"node_id":{"description":"ID of the transfer node that the client access key belongs to.","example":"42","type":"string"},"permission_id":{"example":null,"type":"string"},"root_file_id":{"description":"ID of the directory that this access key grants permissions for.\n","example":"bar","type":"string"},"updated_at":{"description":"Date when the client access key was last updated.","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"workspace_id":{"description":"ID of the workspace that the client access key belongs to.","example":"24","type":"string"}},"type":"object"},"client_authorizations_params":{"properties":{"client_id":{"description":"The ID of the client.","example":"23749","type":"string"},"entity_id":{"description":"The ID of the entity that can be authorized.","example":0,"type":"integer"},"entity_type":{"description":"The type of entity who can be authorized. Default is user.\n","enum":["user","group"],"example":"user","type":"string"}},"required":["client_id","entity_type","entity_id"],"type":"object"},"client_authorizations_response":{"properties":{"client_id":{"description":"The ID of the client.","example":"0","type":"string"},"created_at":{"description":"The timestamp of authorization.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"entity_id":{"description":"The ID of the entity that can be authorized.","example":151,"type":"integer"},"entity_type":{"description":"The type of entity who can be authorized. Default is user.\n","enum":["user","group"],"example":"user","type":"string"},"id":{"description":"The client ID","example":"23749","type":"string"},"updated_at":{"description":"The timestamp of the most recent update.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"}},"type":"object"},"clients_params":{"properties":{"admin_node_token_retrieval_enabled":{"description":"If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Admin permissions required. Defaults to false.","example":false,"type":"boolean"},"explicit_authorization_required":{"description":"Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Admin permissions required. Defaults to true.","example":true,"type":"boolean"},"jwt_grant_enabled":{"description":"Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Admin permissions required.","example":false,"type":"boolean"},"name":{"description":"The name of the client app to register. Admin permissions required. POST: required. PUT: not required.","example":"AoC_Client","type":"string"},"origins":{"description":"The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Array of JSON origins (strings) Admin permissions required. Separate multiple origins with commas. Maximum characters: 65535.","example":["https://ClientOrigin.com"],"items":{"type":"string"},"type":"array"},"public_key":{"description":"RSA public key in PEM format. The corresponding private key can be used to generate a JWT assertion for any user in the organization. Admin permissions required. Maximum characters: 65535.","example":"-----BEGIN PUBLIC KEY-----\nMIIBI ... 7QIDAQAB\n-----END PUBLIC KEY-----","type":"string"},"redirect_uris":{"description":"The allowable list of redirect URIs for the client. A redirect URI (protocol-host-port) is an absolute URI invoked after the authentication flow to return the user to the client app. Array of JSON redirect URIs (strings) Admin permissions required. Separate multiple redirect URIs with commas. Maximum characters: 65535.","example":["https://ClientRedirect.com"],"type":"array","items":{"type":"string"}},"whitelist_enabled":{"description":"Enable creation of a specific list of users and groups eligible to receive an access token. To create the whitelist, see /client_authorizations. Admin permissions required. Pertains to JWT grants. Default is false.","example":true,"type":"boolean"}},"required":["name"],"type":"object"},"clients_response":{"properties":{"admin_node_token_retrieval_enabled":{"description":"If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Default is false.","example":true,"type":"boolean"},"allow_implicit_grant":{"description":"Whether or not to allow the client app to obtain an access token directly from the authorization endpoint, without contacting the token endpoint or authenticating the client.","example":false,"type":"boolean"},"created_at":{"description":"Timestamp of original creation of the client. Datetime.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"creator_id":{"description":"ID of the user who created the client.","example":"0","type":"string"},"explicit_authorization_required":{"description":"Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Default is true.","example":false,"type":"boolean"},"id":{"description":"ID of the client app.","example":"0","type":"string"},"jwt_grant_enabled":{"description":"Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Default is false.","example":false,"type":"boolean"},"name":{"description":"Name assigned to the client. Maximum length: 255 characters.","example":"AoC_Client","type":"string"},"organization_id":{"description":"ID of the AoC organization to which the client belongs.","example":"4","type":"string"},"origins":{"description":"The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Separate multiple origins with commas. Maximum characters: 65535. Array of json origins (strings).","example":["https://origins.com"],"items":{"type":"string"},"type":"array"},"public_key":{"description":"The public portion of the RSA key pair. Maximum characters: 65535.","example":"-----BEGIN PUBLIC KEY-----\nMIIBI ... 7QIDAQAB\n-----END PUBLIC KEY-----","type":"string"},"redirect_uris":{"description":"The allowable list of redirect URIs for this client. A redirect URI, or protocol-host-port, is an absolute URI invoked after the authentication flow to return the user to the client app. Separate multiple redirect URIs with commas. Maximum characters: 65535.","example":["https://redirect.com"],"type":"array","items":{"type":"string"}},"secret":{"description":"The secret associated with this client.","example":"Fw62_Lh7qOK9Z62z-TAwqJncr8Lmej97TbFCnhzd9ShdQ25NxKuLjeOJXSkKrOHuRezeKiXXcuCUoh_hJ1wwzHARdElfsDhw","type":"string"},"updated_at":{"description":"Timestamp of last modification to the client. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"whitelist_enabled":{"description":"Enable creation of a specific list of users and groups eligible to receive an access token. Pertains to JWT grants. Default is false. See /client_authorizations.","example":false,"type":"boolean"}},"type":"object"},"dropbox_memberships_params":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"dropbox_id":{"description":"ID of the dropbox to which this membership belongs.","example":"123","type":"string"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"member_id":{"description":"ID of the member to which this membership belongs.","example":"42","type":"string"},"member_type":{"description":"Describes the kind of member to which this membership belongs.\n","enum":["user","group"],"example":"user","type":"string"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"}},"required":["dropbox_id","member_id"],"type":"object"},"dropbox_memberships_response":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"creator_id":{"description":"ID of the user who created this membership.","example":"42","type":"string"},"dropbox_id":{"description":"ID of the dropbox to which this membership belongs.","example":"123","type":"string"},"id":{"description":"ID of this dropbox membership.","example":"42","type":"string"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"member_id":{"description":"ID of the member to which this membership belongs.","example":"42","type":"string"},"member_type":{"description":"Describes the kind of member to which this membership belongs.\n","enum":["user","group"],"example":"user","type":"string"},"submit_expired":{"description":"Indicates whether the member may make a submission to the dropbox.\n","example":false,"type":"boolean"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace to which this dropbox membership belongs.\n","example":"123","type":"string"}},"type":"object"},"dropbox_memberships_update_params":{"properties":{"can_receive_packages":{"description":"Indicates whether this member can receive packages.\n","example":false,"type":"boolean"},"can_submit_packages":{"description":"Indicates whether this member can submit packages.\n","example":true,"type":"boolean"},"manager":{"description":"Indicates whether this member is a dropbox manager.\n","example":false,"type":"boolean"},"submit_expires_at":{"description":"Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.\n","example":null,"format":"date-time","type":"string"}},"type":"object"},"dropboxes_params":{"properties":{"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"custom_notification_list_enabled":{"description":"For a package sent to a shared inbox, this parameter determines whether notifications are sent to all package addressees or to a user-defined list of addressees for the shared inbox (see dropbox_notification_recipients). Defaults to false. Valid values: true to send notifications to a user-defined list or false to send notifications to all package addressees. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured by this parameter has passed, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the delete_package_content_after_download_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"description":{"description":"A description for the shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":null,"type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this shared inbox by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"dropbox_notification_recipients":{"description":"With custom_notification_list_enabled = true, this parameter defines a list of addressees who should receive notifications regarding packages addressed to this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"id":"email@foo.co","type":"email"}],"items":{"properties":{"id":{"description":"For type = user | group, id denotes the integer ID of that user or group (e.g., \"123\"). For type = email, id denotes the email address of the intended addressee (e.g., \"email@foo.co\").\n","type":"string"},"type":{"enum":["user","group","email"],"type":"string"}},"type":"object"},"type":"array"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notifications specification. See below. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","type":"object"},"enable_external_email_templates":{"description":"If inherit_email_templates is set to false, you can enable or disable the ability to configure email templates specifically for users outside this shared inbox. When this parameter is set to false, external recipients receive the same email notification messages that users in the shared inbox receive. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"image_data":{"description":"The image data for the shared inbox logo encoded as a string. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the shared inbox logo. For example, image/png or image/jpg. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"image/png","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the workspace level. POST Admin or Manager permission required. PUT Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Inherit the email templates configured at the workspace level. If false, you can configure email template settings for this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_workspace_expiration_settings":{"description":"Inherit the content_retention_duration settings configured at the workspace level. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"instructions":{"description":"User-defined instructions for potential shared inbox submissions. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"Video submissions only.","type":"string"},"metadata_schema":{"$ref":"#/components/schemas/metadata"},"name":{"description":"Shared inbox name. A query parameter for the GET method. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"My Shared Inbox","type":"string"},"package_name_and_message_validation_schema":{"description":"Defines illegal characters and/or max length for the name and message fields for package submissions to this shared inbox. Defaults to an empty array ([]). POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"field_name":"package_name","illegal_characters":"!@#","max_length":"100"},{"field_name":"package_message","illegal_characters":"!@#","max_length":"50"}],"items":{"properties":{"field_name":{"enum":["package_name","package_message"],"type":"string"},"illegal_characters":{"description":"Defines all disallowed characters.","example":"!@#","type":"string"},"max_length":{"description":"Defines the max length for the provided string.","example":"50","type":"string"}},"type":"object"},"type":"array"},"personalized_urls_enabled":{"description":"Enable members of this shared inbox to configure personalized URLs to send when inviting people to submit packages. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"workspace_id":{"description":"ID of the workspace to which this shared inbox belongs. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"123","type":"string"}},"required":["name","description","instructions","workspace_id"],"type":"object"},"dropboxes_response":{"properties":{"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. Write only.\n","example":null,"type":"integer"},"custom_notification_list_enabled":{"description":"For a package sent to a shared inbox, this configuration determines whether notifications are sent to all package addressees or a user-defined list of addressees for the shared inbox (see dropbox_notification_recipients). Defaults to false. Valid values: true to send notifications to a user-defined list or false to send notifications to all package addressees. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured by this parameter has passed, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the delete_package_content_after_download_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"description":{"description":"A description for the shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.\n","example":null,"type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this shared inbox by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":null,"type":"integer"},"dropbox_notification_recipients":{"description":"With custom_notification_list_enabled = true, this parameter defines a list of addressees who should receive notifications regarding packages addressed to this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"id":"email@foo.co","type":"email"}],"items":{"properties":{"id":{"description":"For type = user | group, id denotes the integer ID of that user or group (e.g., \"123\"). For type = email, id denotes the email address of the intended addressee (e.g., \"email@foo.co\").\n","type":"string"},"type":{"enum":["user","group","email"],"type":"string"}},"type":"object"},"type":"array"},"effective_content_retention_duration":{"description":"Amount of time in seconds it takes for packages in this shared inbox to be deleted once their transfers complete. If null, packages will not be deleted on a timer. Read-only.\n","example":null,"type":"integer"},"effective_delete_package_content_after_download_duration":{"description":"Amount of time in seconds it takes a package in this shared inbox to be deleted once all recipients have downloaded the entire package. If null, packages will not be deleted on a timer. Read-only.\n","example":null,"type":"integer"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notifications specification. See below. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","type":"object"},"enable_external_email_templates":{"description":"If inherit_email_templates is set to false, you can enable or disable the ability to configure email templates specifically for users outside this shared inbox. When this parameter is set to false, external recipients receive the same email notification messages that users in the shared inbox receive. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"id":{"description":"The ID of the shared inbox. Read-only.","example":"123","type":"string"},"image_url":{"description":"The URL of the shared inbox logo image. Read-only.","example":"https://api.asperafiles.com/api/v1/user_images/32850?oh=cg-nf7pFnNK0-N3g3r-f2nRg","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the workspace level. POST Admin or Manager permission required. PUT Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Inherit the email templates configured at the workspace level. If false, you can configure email template settings for this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"inherit_workspace_expiration_settings":{"description":"Inherit the content_retention_duration settings configured at the workspace level. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":true,"type":"boolean"},"instructions":{"description":"User defined instructions for potential shared inbox submissions. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"Video submissions only.","type":"string"},"metadata_schema":{"$ref":"#/components/schemas/metadata"},"name":{"description":"shared inbox name. A query parameter for the GET method. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"My Dropbox","type":"string"},"package_name_and_message_validation_schema":{"description":"Defines illegal characters and/or max length for the name and message fields for package submissions to this shared inbox. Defaults to an empty array ([]). POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":[{"field_name":"package_name","illegal_characters":"!@#","max_length":"100"},{"field_name":"package_message","illegal_characters":"!@#","max_length":"50"}],"items":{"properties":{"field_name":{"enum":["package_name","package_message"],"type":"string"},"illegal_characters":{"description":"Defines all disallowed characters.","example":"!@#","type":"string"},"max_length":{"description":"Defines the max length for the provided string.","example":"50","type":"string"}},"type":"object"},"type":"array"},"personalized_urls_enabled":{"description":"Enable members of this shared inbox to configure personalized URLs to send when inviting people to submit packages. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":false,"type":"boolean"},"recipients_group_id":{"description":"ID of the group that all shared inbox recipients belong to. Read-only.\n","example":"123","type":"string"},"senders_group_id":{"description":"ID of the group that all senders to the shared inbox belong to. Read-only.\n","example":"123","type":"string"},"workspace_id":{"description":"ID of the workspace to which this shared inbox belongs. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.\n","example":"123","type":"string"}},"type":"object"},"email_notification_settings":{"properties":{"dropbox_invitation":{"description":"An email notification setting; refer to email_notification_settings. Notify users who receive an invitation to send a package to a dropbox. Refer also to public_invites_allowed(_by_managers).","example":true,"type":"boolean"},"file_shared":{"description":"An email notification setting; refer to email_notification_settings. Notify users who are recipients of a shared file. Refer also to public_links_allowed(_by_managers).","example":true,"type":"boolean"},"invitation_to_send_to_me":{"description":"An email notification setting; refer to email_notification_settings. Notify users who receive an invitation to send a package to an individual (as opposed to sending to a dropbox; see dropbox_invitation). Refer also to external_package_sending_allowed(_by_managers).","example":true,"type":"boolean"},"package_contents_deleted":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a package is deleted (senders or administrators can delete packages).","example":true,"type":"boolean"},"package_downloaded":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender when recipients have downloaded the package.","example":true,"type":"boolean"},"package_expired":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when package contents are deleted according to configured package expiration policy (see also delete_package_content_after_download_duration and content_retention_duration).","example":true,"type":"boolean"},"package_failed":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender when a package transfer has failed.","example":true,"type":"boolean"},"package_recalled":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a package has been recalled by the sender. When a package is recalled, the recipient cannot browse or download package contents until the sender resends the package.","example":true,"type":"boolean"},"package_received":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when they have received a package and the package is available.","example":true,"type":"boolean"},"package_resent":{"description":"An email notification setting; refer to email_notification_settings. Notify package recipients when a recalled package has been resent. The package will be available to the recipient when the transfer completes; at that point the recipient receives the package_received notification.","example":true,"type":"boolean"},"package_sent":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender that the package was successfully sent. The package will be available to the recipient when the transfer completes; at that point the recipient receives the package_received notification.","example":true,"type":"boolean"},"package_uploaded":{"description":"An email notification setting; refer to email_notification_settings. Notify package sender that the package was successfully uploaded to the transfer server.","example":true,"type":"boolean"}},"type":"object"},"metadata":{"description":"A metadata schema is used to present a form to a user when the user is submitting content to a dropbox. It is an array with \"Field\" objects, and each Field object defines one field that the user can fill out when submitting content to a dropbox. Note that the order of the fields in the metadata schema array will be the order in which they are shown to the user.\n","example":[{"choices":["opt1","opt2","opt3"],"default_values":["opt2"],"input_type":"single-dropdown","name":"Field 1"}],"items":{"properties":{"choices":{"description":"The value(s) to be configured by the sender. Required for single-dropdown and multiple-checkbox.\n","example":["Option1","Option2"],"items":{"type":"string"},"type":"array"},"default_values":{"description":"Sets the singular default value for each input_type except multiple-checkbox. In the case of multiple-checkbox, a default value is set for each checkbox.\n","example":["Option2"],"items":{"type":"string"},"type":"array"},"illegal_characters":{"description":"Defines all disallowed characters for string fields.","example":"!@#","type":"string"},"input_type":{"description":"The type of the field.","enum":["single-text","date","textbox","single-dropdown","multiple-checkbox"],"type":"string"},"max_length":{"description":"For string fields defines the maximum number of characters allowed.\n","example":"100","type":"string"},"name":{"description":"The label of the metadata field.","type":"string"},"required":{"description":"Denotes a field as required.","example":true,"type":"boolean"}},"required":["name","input_type"],"type":"object"},"type":"array"},"nodes_params":{"properties":{"access_key":{"description":"Access keys are used for authorization when AoC makes a request via the Node API. Each transfer node must have a unique access key.\n","example":"abc123","type":"string"},"ats_access_key":{"description":"Indicates that access_key is a key for an Aspera Transfer Service node. Defaults to false. Used on POST only.\n","example":false,"type":"boolean"},"ats_storage_type":{"description":"For Aspera Transfer Service nodes, this field defines which type of storage is used.\n","enum":["aws_s3","azure","azure-files","azure_sas","google-gcs","ibm-s3","softlayer_swift"],"example":null,"type":"string"},"configuration_policy_id":{"description":"References the configuration policy to which a transfer node belongs.\n","example":null,"type":"integer"},"name":{"description":"User-defined identifier for the transfer node. Each transfer node must have a unique name.","example":"myNode","type":"string"},"network_policy_id":{"description":"References the network configuration policy to which a transfer node belongs.\n","example":null,"type":"integer"},"ssh_fingerprint":{"description":"If your node has SSH capabilities, used for verifying SSH connections.\n","example":null,"type":"string"},"status":{"description":"If a transfer node has status \"error\" but the problem has been fixed, it will automatically recover to the \"ok\" state. Similarly, if a node has status \"ok\", it will switch to status \"error\" automatically if there is a problem. Nodes with status \"down\" remain in the \"down\" state until marked \"ok\" by a user.\n","enum":["ok","error","down"],"example":"error","type":"string"},"url":{"description":"Specifies the URL where the transfer node is located. Necessary for AoC to make requests via the Node API.\n","example":"https://example.com","type":"string"},"use_ssl":{"description":"Describes node secure socket layer usage. Defaults to true.","example":true,"type":"boolean"},"verify_ssl_certificate":{"description":"Specifies whether or not node must verify SSL certificate. Defaults to true.\n","example":true,"type":"boolean"}},"type":"object"},"nodes_response":{"properties":{"host":{"description":"Host portion of node URL.","example":"example.com","type":"string"},"access_key":{"description":"Access keys are used for authorization when AoC makes a request via the Node API. Each transfer node must have a unique access key.\n","example":"abc123","type":"string"},"ats_access_key":{"description":"Indicates that access_key is a key for an Aspera Transfer Service node. Defaults to false. Used on POST only.\n","example":false,"type":"boolean"},"ats_storage_type":{"description":"For Aspera Transfer Service nodes, this field defines which type of storage is used.\n","enum":["aws_s3","azure","azure-files","azure_sas","google-gcs","ibm-s3","softlayer_swift"],"example":null,"type":"string"},"capabilities":{"items":{"properties":{"name":{"type":"string"},"value":{"nullable":true,"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}},"type":"object"},"type":"array"},"configuration_policy_id":{"description":"References the configuration policy to which a node belongs.\n","example":42,"type":"integer"},"error_message":{"description":"Short message describing the nature of the most recent transfer node error.\n","example":"502 Bad Gateway","type":"string"},"error_time":{"description":"Datetime. Indicates time of most recent error.","example":"2019-06-04T04:41:00.000Z","type":"string"},"name":{"description":"User-defined identifier for the transfer node. Each transfer node must have a unique name.","example":"myNode","type":"string"},"network_policy_id":{"description":"References the network configuration policy to which a transfer node belongs.\n","example":42,"type":"integer"},"path":{"description":"Path portion of the transfer node URL.","example":"/","type":"string"},"port":{"description":"Port portion of the transfer node URL.","example":9092,"type":"integer"},"settings":{"items":{"properties":{"name":{"type":"string"},"value":{"nullable":true,"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}},"type":"object"},"type":"array"},"ssh_fingerprint":{"description":"If your node has SSH capabilities, used for verifying SSH connections.\n","example":null,"type":"string"},"status":{"description":"If a transfer node has status \"error\" but the problem has been fixed, it will automatically recover to the \"ok\" state. Similarly, if a node has status \"ok\", it will switch to status \"error\" automatically if there is a problem. Nodes with status \"down\" remain in the \"down\" state until marked \"ok\" by a user.\n","enum":["ok","error","down"],"example":"error","type":"string"},"url":{"description":"Specifies the URL where the transfer node is located. Necessary for AoC to make requests via the Node API.\n","example":"https://example.com:9092/","type":"string"},"use_ssl":{"description":"Describes node secure socket layer usage. Defaults to true.","example":true,"type":"boolean"},"verify_ssl_certificate":{"description":"Specifies whether or not node must verify SSL certificate. Defaults to true.\n","example":true,"type":"boolean"}},"type":"object"},"organizations_params":{"properties":{"background_image_data":{"description":"Data for the image to be displayed on the organization sign-in page. The data must be binary and have a maximum size of 4MB. Returned only when image_data is included in the request (e.g., include%5B%5D=image_data).\n","example":null,"type":"string"},"background_image_type":{"description":"The file type of the background image.","example":"image/gif","type":"string"},"consecutive_login_failures_limit":{"description":"The number of login failures allowed before the user is required to change passwords. Valid values: 2 - 10. Requires organization admin permission to view or update.\n","example":2,"type":"integer"},"default_ear_setting":{"description":"Indicates the default encryption-at-rest setting for your organization. Defaults to false. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"email_footer":{"description":"Text to be added as the footer in email notifications sent for your organization. Must have organization admin permission to view or update.\n","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Must have organization admin permission to view or update."},"enable_external_email_templates":{"description":"Indicates whether the organization has external email templates enabled. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"enforce_password_history_count":{"description":"The number of password changes that must occur before a password can be reused. Valid values are 1 - 12, or null to disable. Requires organization admin permission to view or update.\n","example":3,"type":"integer"},"event_reporting_uri":{"description":"Customer-configurable endpoint that can receive reporting for AoC events. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"google_excluded_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with google_included_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"google_included_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with google_excluded_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"google_oauth_included":{"description":"Indicates whether users can be authenticated through Google OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"inherit_email_templates":{"description":"Indicates whether this organization is using customized email templates. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"invitation_message":{"description":"Text for the email notification that is sent to new users when they are invited to join your organization. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"local_excluded_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with local_included_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"local_included_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with local_excluded_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"local_login_button_text":{"description":"Customized text that will appear on the local login button. Requires organization admin permission to view or update.\n","example":"Log into MyOrganization!","type":"string"},"local_oauth_enabled":{"description":"Indicates whether users can be authenticated through local OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"logo_image_data":{"description":"Data for the image to be used as the organization logo. The data must be binary and have a maximum size of 512KB. This field is included only when the query string includes \"include%5B%5D=image_data\".\n","example":null,"type":"string"},"logo_image_type":{"description":"The data type of the provided logo image.","example":"image/gif","type":"string"},"minimum_password_age":{"description":"Defines the minimum age for a password before it can be reset. Units: seconds. Valid values: 15 minutes to 1 year (900 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":900,"type":"integer"},"minimum_password_length":{"description":"The minimum length for passwords for users in your organization. Valid values: 8 - 100. Requires organization admin permission to view or update.\n","example":8,"type":"integer"},"name":{"description":"The name of your organization.","example":"MyOrganization","type":"string"},"new_user_password_reset_token_duration":{"description":"How long a password reset link is valid, when it is sent as part of an invitation to a new user. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"node_token_duration":{"description":"Denotes the amount of time that a transfer node access token is valid. Must be at least as long as access_token_duration. Units: seconds. Valid values: 1 hour - 14 days (3600 - 1209600). Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"organization_contacts_visible_to_managers":{"description":"If true, workspace managers can see all organization contacts. Otherwise, workspace managers can only see the contacts for their workspace. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"password_expiration_interval":{"description":"How often a password change is required. Units: seconds. Valid values: 15 days to 1 year (129600 - 31536000) or null to disable. Requires organization admin permission to view or update.\n","example":129600,"type":"integer"},"password_reset_token_duration":{"description":"How long the password reset link is good for. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"require_strong_passwords":{"description":"Indicates whether to require users to set \"strong\" passwords. A \"strong\" password contains at least three of the following: 1. A lowercase letter 2. An uppercase letter 3. A non-word character (!, @, #, etc.) 4. A number. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"session_duration":{"description":"How long a user can be inactive before their session is terminated and their access token is invalidated. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable.\n","example":3600,"type":"integer"},"sign_on_message":{"description":"Message displayed to users on sign-in.","example":"Welcome to MyOrganization!","type":"string"},"workspace_container_node_id":{"description":"When creating a workspace, node_id is required, but the client app can choose to use this value as a default. This is set automatically to the first transfer node created in your organization. Requires organization admin permission to view or update.\n","example":"2","type":"string"}},"type":"object"},"organizations_response":{"properties":{"access_token_duration":{"description":"How long an access token is valid. Units: seconds. Valid values: 3600 - 86400 (1 - 24 hours). Viewable by organization admin only.\n","example":3600,"type":"integer"},"access_token_refresh_duration":{"description":"The maximum amount of time that can pass in which an access token can be refreshed. Units: seconds. Valid values: 3600 - 1209600 (1 hour - 14 days), or null to disable access token refreshing. Viewable by organization admin only.\n","example":3600,"type":"integer"},"background_image_data":{"description":"Data for the image to be displayed on the organization sign-in page. The data must be binary and have a maximum size of 4MB. Returned only when image_data is included in the request (e.g. include%5B%5D=image_data).\n","example":null,"type":"string"},"background_image_type":{"description":"The file type of the background image.","example":"image/gif","type":"string"},"background_image_url":{"description":"The URL at which the background image is stored.","example":null,"type":"string"},"consecutive_login_failures_limit":{"description":"The number of login failures allowed before the user is required to change passwords. Valid values: 2 - 10. Requires organization admin permission to view or update.\n","example":2,"type":"integer"},"created_at":{"description":"The time at which the organization was created. Viewable by organization admin only.\n","example":"2019-06-20T17:23:50Z","format":"date-time","type":"string"},"default_ear_setting":{"description":"Indicates the default encryption-at-rest setting for your organization. Defaults to false. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"default_local_login_button_text":{"description":"The default text that appears on the local login button. Viewable by organization admin only.\n","example":"Log in","type":"string"},"email_footer":{"description":"Text to be added as the footer in email notifications sent for your organization. Must have organization admin permission to view or update.\n","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Must have organization admin permission to view or update."},"enable_external_email_templates":{"description":"Indicates whether the organization has external email templates enabled. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"enforce_password_history_count":{"description":"The number of password changes that must occur before a password can be reused. Valid values are 1 - 12, or null to disable. Requires organization admin permission to view or update.\n","example":3,"type":"integer"},"event_reporting_uri":{"description":"Customer-configurable endpoint that can receive reporting for AoC events. Requires organization admin permission to view or update.\n","example":null,"type":"string"},"google_excluded_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with google_included_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"google_included_domains":{"description":"If Google OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with google_excluded_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"google_oauth_included":{"description":"Indicates whether users can be authenticated through Google OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"id":{"description":"The ID of your organization. Read-only.","example":"4","type":"string"},"inherit_email_templates":{"description":"Indicates whether this organization is using customized email templates. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"invitation_message":{"description":"Text for the email notification that is sent to new users when they are invited to join your organization. Requires organization admin permission to view or update.","example":null,"type":"string"},"local_excluded_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are not allowed to log into your organization. This parameter is mutually exclusive with local_included_domains. Requires organization admin permission to view or update.\n","example":[],"items":{"type":"string"},"type":"array"},"local_included_domains":{"description":"If local OAuth is enabled, this parameter can be used to define a list of domains for email addresses that are allowed to log into your organization. This parameter is mutually exclusive with local_excluded_domains. Requires organization admin permission to view or update.\n","example":["example.com","abc.io"],"items":{"type":"string"},"type":"array"},"local_login_button_text":{"description":"Customized text that will appear on the local login button. Requires organization admin permission to view or update.\n","example":"Log into MyOrganization!","type":"string"},"local_oauth_enabled":{"description":"Indicates whether users can be authenticated through local OAuth for your organization. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"logo_image_data":{"description":"Data for the image to be used as organization logo. The data must be binary and have a maximum size of 512KB. This field is included only when the query string includes \"include%5B%5D=image_data\".\n","example":null,"type":"string"},"logo_image_type":{"description":"The data type of the provided logo image.","example":"image/gif","type":"string"},"logo_image_url":{"description":"The URL at which your logo image is stored. Read-only.","example":null,"type":"string"},"minimum_password_age":{"description":"Defines the minimum age for a password before it can be reset. Units: seconds. Valid values: 15 minutes to 1 year (900 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":900,"type":"integer"},"minimum_password_length":{"description":"The minimum length for passwords for users in your organization. Valid values: 8 - 100. Requires organization admin permission to view or update.\n","example":8,"type":"integer"},"name":{"description":"The name of your organization.","example":"MyOrganization","type":"string"},"new_user_password_reset_token_duration":{"description":"How long a password reset link is valid, when it is sent as part of an invitation to a new user. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"node_token_duration":{"description":"Denotes the amount of time that a transfer node access token is valid. Must be at least as long as access_token_duration. Units: seconds. Valid values: 1 hour - 14 days (3600 - 1209600). Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"oauth_token_verification_key":{"description":"RSA public key used to verify OAuth tokens for this org. Requires organization admin permission to view. Read-only.\n","example":"-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n","type":"string"},"organization_contacts_visible_to_managers":{"description":"If true, workspace managers can see all organization contacts. Otherwise, workspace managers can see only the contacts for their workspace. Requires organization admin permission to view or update.\n","example":true,"type":"boolean"},"password_expiration_interval":{"description":"How often a password change is required. Units: seconds. Valid values: 15 days to 1 year (129600 - 31536000), or null to disable. Requires organization admin permission to view or update.\n","example":129600,"type":"integer"},"password_reset_token_duration":{"description":"How long the password reset link is valid. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable. Requires organization admin permission to view or update.\n","example":3600,"type":"integer"},"require_strong_passwords":{"description":"Indicates whether to require users to set \"strong\" passwords. A \"strong\" password contains at least three of the following: 1. A lowercase letter 2. An uppercase letter 3. A non-word character (!, @, #, etc.) 4. A number. Requires organization admin permission to view or update.\n","example":false,"type":"boolean"},"session_duration":{"description":"How long a user can be inactive before their session is terminated and their access token is invalidated. Units: seconds. Valid values: 1 hour - 1 week (3600 - 604800), or null to disable.\n","example":3600,"type":"integer"},"sign_on_message":{"description":"Message displayed to users on sign-in.","example":"Welcome to MyOrganization!","type":"string"},"subdomain_name":{"description":"The subdomain name for your organization. Read-only.","example":"ibm","type":"string"},"tier":{"description":"The tier of your organization's Aspera on Cloud subscription. Can be any of \"paygo\", \"standard\", \"advanced\", or \"enterprise\". Read-only.\n","example":"standard","type":"string"},"trial_expires_at":{"description":"For organizations on trial subscriptions, this denotes the time at which their subscription ends. Is null in all other cases. Read-only.\n","example":null,"format":"date-time","type":"string"},"url_id":{"description":"The URL ID for your organization. Read-only.","example":"abc123","type":"string"},"workspace_container_node_id":{"description":"When creating a workspace, node_id is required, but the client app can choose to use this value as a default. This is set automatically to the first transfer node created in your organization. Requires organization admin permission to view or update.\n","example":"2","type":"string"}},"type":"object"},"packages_params":{"properties":{"archived":{"description":"Whether or not this package has been archived by the user.","example":false,"type":"boolean"},"bcc_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"content_retention_duration":{"description":"When a time-based content expiration value is set for this package, the duration to retain packages contents. When this duration passes, the packages contents are deleted. Valid values are null to 10 years. Units are seconds.","example":null,"type":"integer"},"delete_package_content_after_download_duration":{"description":"If 'delete_after_download' is set to 'true', this parameter configures an optional 'grace period', during which the package contents will be retained even after all recipients have downloaded the package. The timer for this setting begins when all recipients have downloaded the package; when the timer expires, the package contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"download_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"draft":{"description":"Whether or not the package is in draft status.","example":true,"type":"boolean"},"encryption_at_rest":{"description":"Whether or not the package has encryption_at_rest applied. For transfers that use the Aspera Connect transfer client, note this requirement to enable Connect to decrypt package contents. When a package is uploaded with encryption-at-rest set to true, the parameter single-source must also be true.","example":false,"type":"boolean"},"file_names":{"description":"The names of the items to include in this package; multiple names separated by commas. Maximum characters: 65535","example":"file.txt, file2.txt","type":"string"},"metadata":{"description":"JSON object. Maximum characters: 65535","example":"","type":"object"},"name":{"description":"Package name. Required for POST. Optional for PUT.","example":"Name of Package","type":"string"},"note":{"description":"The sender's message to recipients to include with the package. Maximum characters: 65535.","example":"Please review and process asap.","type":"string"},"read":{"description":"Whether or not the package was read.","example":false,"type":"boolean"},"recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"sent":{"description":"Whether or not the package was sent.","example":false,"type":"boolean"},"single_source":{"description":"Whether or not all the contents of this package originate from the same location (node, workstation, etc.). When the package recipient downloads a package with Encryption at Rest (EAR) applied by the sender, and all package contents are from the same source (single-source=true; for example, the sender's desktop; a specific remote server), AoC signals Aspera Connect to prompt the recipient to apply the passphrase created by the sender and decrypt package contents during the download operation. When package contents are from disparate sources, the recipient applies the password to individual files in the downloaded package when opening each file.","example":false,"type":"boolean"},"transfers_expected":{"description":"The number of transfer sessions expected to bring all package contents to the node supporting the workspace in which the package is sent. The number corresponds to the number of discrete source locations of the designated package contents. For example, if the package includes 20 files and folders from 5 discrete sources, the number of transfers expected is 5.","example":3,"type":"integer"},"upload_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"workspace_id":{"description":"The ID of the workspace from which this package was sent. Required for POST. Optional for PUT.","example":65,"type":"integer"}},"required":["name","workspace_id"],"type":"object"},"packages_response":{"properties":{"active_download_count":{"description":"The number of active downloads.","example":12,"type":"integer"},"archived":{"description":"Whether or not this package has been archived by the user. If user_package only.","example":false,"type":"boolean"},"average_rate":{"description":"Float. User Packages.","example":871.096,"type":"number"},"bcc":{"description":"Whether or not there is a BCC list. If user_package only.","example":true,"type":"boolean"},"bcc_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"bytes_transferred":{"description":"How many bytes have been transferred.","example":546,"type":"integer"},"complete":{"description":"Whether or not the package is fully available on the transfer node; when the package is complete, all transfers of the designated files and folders into the package have been successful and all designated files and folders are present on the node.","example":false,"type":"boolean"},"completed_at":{"description":"The timestamp that indicates when the package is complete. Refer to 'complete'.","example":"2018-02-06T00:05:25Z","format":"date-time","type":"string"},"content_expires_at":{"description":"The time at which package content will expire according to configured expiration policies. Refer to 'content_retention_duration' and to the related parameters 'delete_after_download' and 'delete_package_content_after_download_duration'.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"content_retention_duration":{"description":"When a time-based content expiration value is set for this package, the duration to retain packages contents. When this duration passes, the packages contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"contents_file_id":{"description":"The file ID on the node that contains package contents.","example":"479283475","type":"string"},"created_at":{"description":"The timestamp for when this package was created.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"delete_after_download":{"description":"Whether or not an expiration policy applies to this package, indicating that package contents will expire (be deleted) after all recipients have downloaded the package.","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"If 'delete_after_download' is set to 'true', this parameter configures an optional 'grace period', during which the package contents will be retained even after all recipients have downloaded the package. The timer for this setting begins when all recipients have downloaded the package; when the timer expires, the package contents are deleted. Valid values are null - 10 years. Units are seconds.","example":null,"type":"integer"},"deleted":{"description":"Whether or not package contents have been deleted, either by the sender, by an administrator, or by configured expiration policies.","example":false,"type":"boolean"},"deleted_after_download":{"description":"Whether or not package contents were deleted by a download-based expiration policy.","example":false,"type":"boolean"},"deleted_at":{"description":"The timestamp for the deletion of package contents.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"deleted_by_admin":{"description":"Whether or not the deleted package was deleted by an administrator.","example":false,"type":"boolean"},"deleted_by_user_id":{"description":"The ID of the user who deleted the package.","example":151,"type":"integer"},"download_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"draft":{"description":"Whether or not the package is in draft status.","example":true,"type":"boolean"},"draft_expires_at":{"description":"The time the draft expired/expires.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"encryption_at_rest":{"description":"Whether or not the package has encryption_at_rest applied.","example":false,"type":"boolean"},"expiration_reason":{"description":"The reason for expiration. Package can be deleted by an administrator or by the sender, or can be deleted as a result of a configured time-based or download-based expiration policy.","example":"contents_expired","type":"string"},"expired":{"description":"Whether or not the package contents are expired due to a configured expiration policy.","example":false,"type":"boolean"},"expired_at":{"description":"The time the package expired/expires.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"failed":{"description":"Whether or not the transfer of this package failed.","example":false,"type":"boolean"},"failed_download_count":{"description":"The number of failed downloads of this package; download attempts may be full (the entire package) or partial (some contents of the package).","example":0,"type":"integer"},"file_count":{"description":"The number of files included in this package. This counts individual files included in the package, not files that are contents of folders that are included in the package.","example":21,"type":"integer"},"file_count_from_disk":{"description":"Whether or not the file_count value was obtained from the storage.","example":false,"type":"boolean"},"file_id":{"description":"The ID for the file comprising all package contents.","example":"7","type":"string"},"files_completed":{"description":"The number of files that have completed transferring.","example":46,"type":"integer"},"files_expected":{"description":"Number (obtained directly from the node) of files expected to be transferred as part of the package.","example":54,"type":"integer"},"folder_count":{"description":"The number of folders actually included in this package per the transfer session. This counts individual folder included in the package, not folders that are nested within other folders that are included in the package. This value may or may not match the value for folders_expected.","example":5,"type":"integer"},"folders_completed":{"description":"Number (obtained directly from the node) of folders successfully transferred as part of the package.","example":7,"type":"integer"},"folders_expected":{"description":"Number (obtained directly from the node) of folders expected to be transferred as part of the package.","example":8,"type":"integer"},"full_download_count":{"description":"The number of full downloads completed for this package. This counts the times that recipients have downloaded the package as a whole, rather than partial downloads, when a recipient downloads individual files or folders of a package.","example":4,"type":"integer"},"has_content":{"description":"Whether or not the package has contents. If content has been deleted, either by the user, by an administrator, or as the result of configured package expiration policies, the package record remains accessible, but the package content has been deleted from the transfer server and cannot be recovered.","example":false,"type":"boolean"},"id":{"description":"The ID for the package.","example":"87234","type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"name":{"description":"Package name.","example":"test package","type":"string"},"node_id":{"description":"The ID of the node that contains the package.","example":21,"type":"integer"},"note":{"description":"The sender's message to recipients to include with the package. Maximum characters: 65535.","example":"Please download and process asap. Thanks.","type":"string"},"package_sent":{"example":7},"read":{"description":"Whether or not the package was read. If user_package only.","example":false,"type":"boolean"},"recalled_at":{"description":"When the package was recalled.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"received":{"description":"Whether or not the package was received. If user_package only.","example":true,"type":"boolean"},"recipients":{"allOf":[{"$ref":"#/components/schemas/senders_recipients_object"}],"description":"If not user_package only."},"sender":{"$ref":"#/components/schemas/senders_recipients_object"},"sent":{"description":"Whether or not the package was sent.","example":true,"type":"boolean"},"sent_at":{"description":"The timestamp for when the package was sent.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"single_source":{"description":"Whether or not all the contents of this package originate from the same location (node, workstation, etc.). When the package recipient downloads a package with Encryption at Rest (EAR) applied by the sender or by workspace configuration, and all package contents are from the same source (for example, the sender's desktop; a specific remote server), AoC signals Aspera Connect to prompt the recipient to apply the passphrase created by the sender and decrypt package contents during the download operation. When package contents are from disparate sources, previous behavior applies: the recipient applies the password to individual files in the downloaded package when opening each file.","example":false,"type":"boolean"},"size":{"description":"The cumulative size of all the files and folders in the package.","example":345543,"type":"integer"},"time_remaining":{"description":"The time remaining to complete an in-progress transfer. Float.","example":1.3,"type":"number"},"transfers_expected":{"description":"The number of transfer sessions expected to bring all package contents to the node supporting the workspace in which the package is sent. The number corresponds to the number of discrete source locations of the designated package contents. For example, if the package includes 20 files and folders from 5 discrete sources, the number of transfers expected is 5.","example":7,"type":"integer"},"updated_at":{"description":"When the package was updated.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"upload_notification_recipients":{"$ref":"#/components/schemas/senders_recipients_object"},"upload_started":{"description":"Whether or not the upload of the package has started.","example":false,"type":"boolean"},"upload_started_at":{"description":"The timestamp for when the package upload began.","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace from which this package was sent.","example":64792,"type":"integer"}},"type":"object"},"senders_recipients_object":{"properties":{"id":{"description":"The ID of the recipient.","type":"string"},"type":{"description":"The entity type of the recipient.","enum":["user","group"],"type":"string"}},"required":["id"],"type":"object"},"usage_reports_response":{"properties":{"node_id":{"description":"The ID of the transfer node for which this usage report was generated.","example":"1","type":"string"},"reporting_period_bytes":{"description":"The total number of bytes transferred during this reporting period.\n","example":1024,"type":"integer"},"reporting_period_bytes_in":{"description":"The total number of bytes received during this reporting period.\n","example":512,"type":"integer"},"reporting_period_bytes_out":{"description":"The total number of bytes sent during this reporting period.","example":512,"type":"integer"},"total_bytes":{"description":"The total number of bytes transferred since the transfer node started collecting usage information.\n","example":2048,"type":"integer"},"total_bytes_in":{"description":"The total number bytes received since the transfer node started collecting usage information.\n","example":1024,"type":"integer"},"total_bytes_out":{"description":"The total number of bytes sent since the transfer node started collecting usage information.\n","example":1024,"type":"integer"},"updated_at":{"description":"The date at which this usage report was last updated.","example":"2019-06-18T21:46:36.000Z","format":"date-time","type":"string"},"workspace_id":{"description":"The ID of the workspace for which this usage report was generated.\n","example":"2","type":"string"}},"type":"object"},"users_params":{"properties":{"avatar_image_data":{"description":"PUT User, Manager, Admin for self.","type":"string"},"avatar_image_type":{"description":"The image type of the avatar image data. PUT User, Manager, Admin for self.","type":"string"},"deactivated":{"description":"Whether or not this user is deactivated. A deactivated user cannot log in to Aspera on Cloud, but still exists in the user database. PUT Admin permission required.","example":false,"type":"boolean"},"default_workspace_choice":{"description":"The workspace selected by the user as their default; when the user logs in to Aspera on Cloud, the default workspace displays. If the user has not selected a default workspace, the last used workspace displays. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"last_used","type":"string"},"default_workspace_id":{"description":"The ID of the user-selected default workspace. If the user has not selected a default workspace, the field contains the ID of the user's last used workspace. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"5988","type":"string"},"email":{"description":"The email address associated with this user in the AoC user database. This is the user's login username. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required. Required only for POST.","example":"email@example.com","type":"string"},"first_name":{"description":"The user's first name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Arthur","type":"string"},"ibm_uid":{"description":"The ID for the user. PUT User, Manager, Admin for self.","example":0,"type":"integer"},"last_name":{"description":"The user's last name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Lumra","type":"string"},"name":{"description":"The user first_name and last_name. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":"Arthur Lumra","type":"string"},"organization_admin":{"description":"Whether or not this user has administrative privileges in the organization. PUT Admin permission required.","example":false,"type":"boolean"},"provisioned":{"description":"Whether or not the user's home folder is ready for use.","example":false,"type":"boolean"},"public_key":{"description":"Whether or not the user record for this user includes the user's public key. The user can add their public key to their record, or the organization administrator can add it. PUT User, Manager, Admin for self. POST Manager permission required. POST Admin permission required.","example":false,"type":"boolean"},"subscription_admin":{"description":"future feature PUT Admin permission required.","example":false,"type":"boolean"},"user_admin":{"description":"future feature PUT Admin permission required.","example":false,"type":"boolean"}},"required":["email"],"type":"object"},"users_response":{"properties":{"ats_admin":{"description":"Whether or not this user has ATS (Aspera Transfer Service) administrative permissions.","example":false,"type":"boolean"},"available_apps":{"description":"future feature","type":"string"},"created_at":{"description":"The timestamp for initial creation of this user. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"deactivated":{"description":"Whether or not this user is deactivated. A deactivated user cannot log in to Aspera on Cloud, but still exists in the user database.","example":false,"type":"boolean"},"default_shortlink_name":{"description":"When shortened links are enabled for a workspace, and this user has permission to send an invitation inviting another person to send them a package, this is the default configuration of the shortened link for this user. The default shortened link is comprised of 'first_name' and 'last_name' for this user.","example":"artik_lumra","type":"string"},"default_workspace_choice":{"description":"The workspace selected by the user as their default; when the user logs in to Aspera on Cloud, the default workspace displays. If the user has not selected a default workspace, the last used workspace displays.","example":"last_used","type":"string"},"default_workspace_id":{"description":"The ID of the user-selected default workspace. If the user has not selected a default workspace, the field contains the ID of the user's last used workspace.","example":0,"type":"string"},"email":{"description":"The email address associated with this user in the Aspera on Cloud user database. This is the user's login username.","example":"email@example.com","type":"string"},"first_name":{"description":"The user's first name.","example":"Arthur","type":"string"},"home_file_id":{"description":"The file ID of the user's root or home folder, which contains all files and folders the user uploads, along with links to folders shared with this user by the administrator or by other users.","example":0,"type":"integer"},"home_node_id":{"description":"The ID of the node containing the user's home folder.","example":0,"type":"integer"},"id":{"description":"The ID for the user.","example":0,"type":"integer"},"last_login_at":{"description":"The timestamp for the last time the user logged in. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"last_login_provider":{"description":"The authorization method used for the most recent login.","example":"saml","type":"string"},"last_name":{"description":"The user's last name.","example":"Bartlance","type":"string"},"member_of_any_workspace":{"description":"Whether or not the user has membership in any workspace. Refer to .","example":false,"type":"boolean"},"name":{"description":"The user first_name and last_name.","example":"Artik","type":"string"},"organization_admin":{"description":"Whether or not this user has administrative privileges in the organization.","example":false,"type":"boolean"},"organization_id":{"description":"ID of the AoC organization to which the client belongs.","example":4,"type":"integer"},"password_updated_at":{"description":"The timestamp for the most recent update to the user password. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"provisioned":{"description":"Whether or not the user's home folder is ready for use.","example":false,"type":"boolean"},"public_key":{"description":"Whether or not the user record for this user includes the user's public key. The user can add their public key to their record, or the organization administrator can add it.","example":false,"type":"boolean"},"read_only_home_file_id":{"description":"The file ID of the home folder for a user who may have access to some shared folders in the workspace, but is not a member of the workspace.","example":"873398","type":"string"},"read_only_home_node_id":{"description":"The ID of the node containing the user's read-only home folder.","example":3214,"type":"integer"},"running_operation_count":{"description":"The number of user-related operations currently in progress.","example":34,"type":"integer"},"saml_configuration_id":{"description":"The ID for this user in the SAML authentication login. If user is not a SAML user, set this parameter to null.","example":null,"type":"string"},"stopped_operation_count":{"description":"The number of user-related operations that are stopped for any reason.","example":12,"type":"integer"},"subscription_admin":{"description":"future feature","example":false,"type":"boolean"},"trial":{"description":"Whether or not this org/user is a trial","example":false,"type":"boolean"},"updated_at":{"description":"The timestamp for when the user record was most recently updated. datetime","example":"2018-02-06T00:03:24Z","format":"date-time","type":"string"},"user_admin":{"description":"future feature","example":false,"type":"boolean"}},"type":"object"},"workspace_filter_params":{"properties":{"created_at":{"format":"date-time","type":"string"},"manager":{"type":"boolean"},"name":{"type":"string"},"node_id":{"type":"integer"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"workspace_memberships_params":{"properties":{"can_invite_by_email":{"description":"Whether or not inviting users to this workspace by email is allowed.","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"member_id":{"description":"The ID of the member","example":0,"type":"integer"},"member_type":{"description":"The member type.","example":"user","type":"string"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"},"workspace_id":{"description":"The ID of the workspace in which to grant this membership.","example":0,"type":"integer"}},"required":["member_id","member_type","workspace_id"],"type":"object"},"workspace_memberships_response":{"properties":{"id":{"description":"Membership ID.","example":0,"type":"string"},"inherited":{"description":"The membership in this workspace is 'inherited'. The user is not a direct member, but rather a member by means of being a member of a group that is a member of the workspace.","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"member_id":{"description":"The ID of the member.","example":0,"type":"integer"},"member_type":{"description":"The user type for this member. Valid values- user, group.","example":"user","type":"string"},"running_operation_count":{"description":"The number of workspace-membership-related operations currently in progress.","example":0,"type":"integer"},"stopped_operation_count":{"description":"The number of workspace-membership-related operations that are stopped for any reason.","example":0,"type":"integer"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"},"workspace_id":{"description":"The ID of the workspace.","example":0,"type":"integer"}},"type":"object"},"workspace_memberships_update_params":{"properties":{"can_invite_by_email":{"description":"Whether or not inviting users to this workspace by email is allowed.\n","example":false,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type.","example":false,"type":"boolean"},"storage_allowed":{"description":"Whether or not storage is allowed.","example":false,"type":"boolean"}},"type":"object"},"workspace_query_params":{"properties":{"created_at":{"format":"date-time","type":"string"},"manager":{"type":"boolean"},"name":{"description":"full text search","type":"string"},"node_id":{"type":"integer"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"workspaces_params":{"properties":{"allow_package_level_expirations":{"description":"Allow senders to set package expiration when sending. If workspace settings are configured by the admin, senders can only further restrict the workspace setting. Refer to delete_package_content_after_download_duration and to content_retention_duration. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_settings_editable_by_managers":{"description":"Allow workspace manager to configure workspace collaboration settings. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_whitelist_enabled":{"description":"If collaboration with users outside the workspace is enabled (external_package_sending_allowed=true and/or external_sharing_allowed=true), enable a whitelist of external users who can be recipients of packages and/or shared folders. To configure the whitelist, POST or PUT to /workspace_collaborators. POST: Admin permission required. PUT: Manager with collaboration settings edit permission or Admin permission required. settings editable by managers required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_with_emails_allowed":{"description":"If external_package_sending_allowed(_by_managers) and/or external_sharing_allowed(_by_managers) is/are set to true, setting this parameter to true allows those who are allowed to send to or share with external users (all users or workspace managers only) to see email addresses of external users in the list of contacts displayed in the (1) recipients field of the package sending form, and/or (2) the recipients field of the folder sharing form. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on time. To set a download-based expiration policy, refer to delete_package_content_after_download_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"default_ear_setting":{"description":"When this parameter is set to true, encryption-at-rest is mandatory for all packages sent in this workspace. Senders must set a passphrase for every package they send, then must deliver the passphrase to the recipient according to local site security practice. Only when the recipient applies that passphrase can the package be decrypted. When this parameter is set to true, the parameter of the /packages endpoint that corresponds to EAR is always set to true and cannot be edited. When this parameter is set to false, the field in the /packages endpoint can be set to true or false, giving the sender the choice whether to apply EAR to a given package or not. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on whether or not recipients have downloaded the package. To set a time-based expiration policy, refer to content_retention_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"description":{"description":"A description for the workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).","example":"Maximum characters: 65535","type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this workspace by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If null, contents of draft packages in this workspace are not deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer to content_retention_duration. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"email_footer":{"description":"If 'inherit_email_templates' is set to false, configure the footer for email notifications for this workspace. The footer you configure is common to all email notifications for this workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notification specification. See below. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE Admin scope (org admin).","type":"object"},"enable_external_email_templates":{"description":"If 'inherit_email_templates' is set to false, you can enable or disable the ability to configure email templates specifically for users outside this workspace. When this parameter is set to false, external recipients receive the same email notification messages that users in the workspace receive. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"enable_external_notifications":{"description":"Not used.","example":true,"type":"boolean"},"event_reporting_headers":{"description":"If event_reporting_uri is configured, users can submit JSON of all acceptable headers. If event_reporting_uri is not configured, this parameter does not apply. POST: Admin permission required. Maximum characters: 65535.","example":"","type":"string"},"event_reporting_uri":{"description":"The URI to collect event and activity reports. If this parameter is not null, you can use the event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"external_package_authentication_required":{"description":"Require external recipients of packages sent from this workspace to authenticate before they can access the package. POST: Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"external_package_sending_allowed":{"description":"Allow members of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_package_sending_allowed_by_managers":{"description":"Allow workspace managers of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have a Files account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_sharing_allowed":{"description":"Allow members of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"external_sharing_allowed_by_managers":{"description":"Allow workspace managers of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"home_container_file_id":{"description":"The file ID of the folder containing users' home folders for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"5","type":"string"},"image_data":{"description":"The image data encoded as a string. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope if params[:include]=true. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the workspace logo; for example, image/png or image/jpg. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"image/png","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the organization. If set to false, you can configure external email notification settings for this workspace; see 'enable_external_notifications'. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Whether or not to inherit the email templates configured at the organization. If set to true, the workspace inherits the settings configured at the organization level. If set to false, you can configure email template settings for this workspace; see 'enable_external_email_templates' and other email notification settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_external_notifications":{"description":"Whether or not the workspace inherits external notifications. PUT Admin permission required.","example":false,"type":"boolean"},"invitations_allowed":{"description":"Allow members of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"invitations_allowed_by_managers":{"description":"Allow workspace managers of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"name":{"description":"The workspace name. Query parameter for GET method. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"My New Workspace","type":"string"},"node_id":{"description":"The ID of the node on which workspace folders and packages are stored. Query parameter for GET method. POST Admin permission required. PUT Manager permission required.","example":14,"type":"integer"},"package_download_counts_enabled":{"description":"Whether or not package download counts are recorded. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"personalized_urls_enabled":{"description":"Enable members of this workspace to configure personalized URLs to send when inviting people to submit packages (refer to public_links_allowed). You can set this parameter to true only if url_shortening_enabled is also set to true. Once you enable personalized URLs, you enable a default personalized URL construction and you also allow workspace member to configure the URLs they send. The default URL configuration contains the sender's username or the dropbox name; for example: https://aspera.pub/John_Doe;https://aspera.pub/Dropbox1. Note that dropboxes in the workspace inherit the settings you configure for the workspace as follows: When short URLs are enabled at the workspace (url_shortening_enabled=true): Short URLs are enabled for all dropboxes in that workspace. You cannot disable short URLs for a dropbox. When personalized URLs are enabled at the workspace: Personalized URLs are enabled for all dropboxes in that workspace. You can disable personalized URLs for specific dropboxes if desired. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":false,"type":"boolean"},"public_invites_allowed":{"description":"Allow workspace members to send invitations to users outside the workspace, inviting them to send a package to (1) the user who issues the invitation, and (2) the dropboxes in which the user who issues the invitation is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"public_invites_allowed_by_managers":{"description":"Allow workspace managers to send invitations to users outside the workspace, inviting them to send a package to (1) the workspace manager who issues the invitation, and (2) the dropboxes in which the workspace manager is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed":{"description":"Allow users in the workspace to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed_by_managers":{"description":"Allow workspace managers to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"root_file_id":{"description":"The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"spool_file_id":{"description":"Where packages are stored POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"4","type":"string"},"storage_allowed":{"description":"Whether or not the users of this workspace can upload to their respective home folders. Set this parameter to false to prevent users from uploading to or creating new folders in their home folders. Restricting these functions is one way to control storage usage in the workspace. To exempt certain workspace members from this restriction, set storage_allowed to true for those members in /workspace_memberships. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"url_shortening_enabled":{"description":"When members of this workspace send a link that allows the recipeint to send a package (refer to public_invites_allowed), the link generated will have the shortened form; for example: (compared to the standard URL; for example: ). When this parameter is set to true, you can also set personalized_urls_enabled to true. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"}},"required":["name","node_id"],"type":"object"},"workspaces_response":{"properties":{"allow_package_level_expirations":{"description":"Allow senders to set package expiration when sending. If workspace settings are configured by the admin, senders can only further restrict the workspace setting. Refer to delete_package_content_after_download_duration and to content_retention_duration. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"can_invite_by_email":{"description":"RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"collaboration_settings_editable_by_managers":{"description":"Allow workspace manager to configure workspace collaboration settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_whitelist_enabled":{"description":"If collaboration with users outside the workspace is enabled (external_package_sending_allowed=true and/or external_sharing_allowed=true), enable a whitelist of external users who can be recipients of packages and/or shared folders. To configure the whitelist, POST or PUT to /workspace_collaborators. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"collaboration_with_emails_allowed":{"description":"If external_package_sending_allowed(_by_managers) and/or external_sharing_allowed(_by_managers) is/are set to true, setting this parameter to true allows those who are allowed to send to or share with external users (all users or workspace managers only) to see email addresses of external users in the list of contacts displayed in the (1) recipients field of the package sending form, and/or (2) the recipients field of the folder sharing form. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"content_retention_duration":{"description":"Configure a time-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once the transfer complete, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on time. To set a download-based expiration policy, refer to delete_package_content_after_download_duration. Valid values (null - 10 years) Units (seconds) POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"created_at":{"description":"datetime RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"2018-02-16T04:30:58Z","format":"date-time","type":"string"},"default_ear_setting":{"description":"When this parameter is set to true, encryption-at-rest is mandatory for all packages sent in this workspace. Senders must set a passphrase for every package they send, then must deliver the passphrase to the recipient according to local site security practice. Only when the recipient applies that passphrase can the package be decrypted. When this parameter is set to true, the parameter of the /packages endpoint that corresponds to EAR is always set to true and cannot be edited. When this parameter is set to false, the field in the /packages endpoint can be set to true or false, giving the sender the choice whether to apply EAR to a given package or not. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"delete_package_content_after_download_duration":{"description":"Configure a download-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on whether or not recipients have downloaded the package. To set a time-based expiration policy, refer to content_retention_duration. Valid values (null - 10 years) Units (seconds) POST Admin permission required. PUT Manager permission required. or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"description":{"description":"A description for the workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"Maximum characters: 65535","type":"string"},"draft_expiration_duration":{"description":"Configure a time-based expiration policy for draft packages in this workspace by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If null, contents of draft packages in this workspace are not deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer to content_retention_duration. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":null,"type":"integer"},"effective_default_ear_setting":{"description":"RESPONSE User scope. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"effective_storage_allowed":{"description":"RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"email_footer":{"description":"If 'inherit_email_templates' is set to false, configure the footer for email notifications for this workspace. The footer you configure is common to all email notifications for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"email_notification_settings":{"allOf":[{"$ref":"#/components/schemas/email_notification_settings"}],"description":"Email notification specification. See below. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","type":"object"},"enable_external_email_templates":{"description":"If 'inherit_email_templates' is set to false, you can enable or disable the ability to configure email templates specifically for users outside this workspace. When this parameter is set to false, external recipients receive the same email notification messages that users in the workspace receive. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"enable_external_notifications":{"description":"Not used. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"event_reporting_headers":{"description":"If event_reporting_uri is configured, users can submit JSON of all acceptable headers. If event_reporting_uri is not configured, this parameter does not apply. POST Admin permission required.","example":"Maximum characters: 65535","type":"string"},"event_reporting_uri":{"description":"The URI to collect event and activity reports. If this parameter is not null, you can use the event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"external_package_authentication_required":{"description":"Require external recipients of packages sent from this workspace to authenticate before they can access the package. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"external_package_sending_allowed":{"description":"Allow members of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_package_sending_allowed_by_managers":{"description":"Allow workspace managers of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"external_sharing_allowed":{"description":"Allow members of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"external_sharing_allowed_by_managers":{"description":"Allow workspace managers of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"group_id":{"description":"The ID of the group containing all members of this workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":4,"type":"integer"},"home_container_file_id":{"description":"The file ID of the folder containing users' home folders for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"5","type":"string"},"home_file_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"},"home_node_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"},"id":{"description":"The ID of the workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"3","type":"string"},"image_data":{"description":"The image data encoded as a string. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope if params[:include]=true. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"iVBORw0KGgo ... /wB\\/DRk84ZdwGQAAAABJRU5ErkJggg==","type":"string"},"image_type":{"description":"The image type of the workspace logo; for example, image/png or image/jpg. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"image/png","type":"string"},"image_url":{"description":"The URL of the image. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"https://api.asperafiles.com/api/v1/user_images/32850?oh=cg-nf7pFnNK0-N3g3r-f2nRg","type":"string"},"inherit_email_notification_settings":{"description":"Inherit the email notification settings configured at the organization. If set to false, you can configure external email notification settings for this workspace; see 'enable_external_notifications'. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_email_templates":{"description":"Whether or not to inherit the email templates configured at the organization. If set to true, the workspace inherits the settings configured at the organization level. If set to false, you can configure email template settings for this workspace; see 'enable_external_email_templates' and other email notification settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"inherit_external_notifications":{"description":"Whether or not the workspace inherits external notifications. PUT Admin permission required.","example":false,"type":"boolean"},"invitations_allowed":{"description":"Allow members of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"invitations_allowed_by_managers":{"description":"Allow workspace managers of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"manager":{"description":"The user is a workspace manager user type. RESPONSE User scope if is_workspace_membership.","example":false,"type":"boolean"},"managers_group_id":{"description":"The ID of the group containing all manager of this workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":0,"type":"integer"},"member":{"description":"The user is part of the workspace. RESPONSE User scope. RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"name":{"description":"The workspace name. Query parameter for GET method. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":"My New Workspace","type":"string"},"node_id":{"description":"The ID of the node on which workspace folders and packages are stored. Query parameter for GET method. POST Admin permission required. PUT Manager permission required.","example":14,"type":"integer"},"package_download_counts_enabled":{"description":"Whether or not package download counts are recorded. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":false,"type":"boolean"},"personalized_urls_enabled":{"description":"Enable members of this workspace to configure personalized URLs to send when inviting people to submit packages (refer to public_links_allowed). You can set this parameter to true only if url_shortening_enabled is also set to true. Once you enable personalized URLs, you enable a default personalized URL construction and you also allow workspace member to configure the URLs they send. The default URL configuration contains the sender's username or the dropbox name; for example: https://aspera.pub/John_Doe;https://aspera.pub/Dropbox1. Note that dropboxes in the workspace inherit the settings you configure for the workspace as follows: When short URLs are enabled at the workspace (url_shortening_enabled=true): Short URLs are enabled for all dropboxes in that workspace. You cannot disable short URLs for a dropbox. When personalized URLs are enabled at the workspace: Personalized URLs are enabled for all dropboxes in that workspace. You can disable personalized URLs for specific dropboxes if desired. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":false,"type":"boolean"},"public_invites_allowed":{"description":"Allow workspace members to send invitations to users outside the workspace, inviting them to send a package to (1) the user who issues the invitation, and (2) the dropboxes in which the user who issues the invitation is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.","example":true,"type":"boolean"},"public_invites_allowed_by_managers":{"description":"Allow workspace managers to send invitations to users outside the workspace, inviting them to send a package to (1) the workspace manager who issues the invitation, and (2) the dropboxes in which the workspace manager is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed":{"description":"Allow users in the workspace to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"public_links_allowed_by_managers":{"description":"Allow workspace managers to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"root_file_id":{"description":"The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":null,"type":"string"},"spool_file_id":{"description":"Where packages are stored POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":"4","type":"string"},"storage_allowed":{"description":"Whether or not the users of this workspace can upload to their respective home folders. Set this parameter to false to prevent users from uploading to or creating new folders in their home folders. Restricting these functions is one way to control storage usage in the workspace. To exempt certain workspace members from this restriction, set storage_allowed to true for those members in /workspace_memberships. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"updated_at":{"description":"datetime RESPONSE User scope. RESPONSE Admin scope (org admin).","example":"2018-02-16T04:30:58Z","format":"date-time","type":"string"},"url_shortening_enabled":{"description":"When members of this workspace send a link that allows the recipient to send a package (refer to public_invites_allowed), the link generated will have the shortened form; for example: (compared to the standard URL; for example: ). When this parameter is set to true, you can also set personalized_urls_enabled to true. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).","example":true,"type":"boolean"},"user_id":{"description":"RESPONSE User scope if is_workspace_membership.","example":0,"type":"integer"}},"type":"object"}},"securitySchemes":{"HTTP_Basic":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"x-ibm-configuration":{"enforced":false,"testable":true,"phase":"realized","cors":{"enabled":true}}} \ No newline at end of file diff --git a/openapi/IBM Aspera on Cloud API-0.2.6.yaml b/openapi/IBM Aspera on Cloud API-0.2.6.yaml index 85702d2..7d9ef79 100644 --- a/openapi/IBM Aspera on Cloud API-0.2.6.yaml +++ b/openapi/IBM Aspera on Cloud API-0.2.6.yaml @@ -3237,7 +3237,7 @@ components: invitation_to_send_to_me: description: >- An email notification setting; refer to email_notification_settings. - Notifiy users who receive an invitation to send a package to an + Notify users who receive an invitation to send a package to an individual (as opposed to sending to a dropbox; see dropbox_invitation). Refer also to external_package_sending_allowed(_by_managers).