{ "openapi":"3.0", "info":{ "title":"Developer API for File Server in Oracle Integration 3", "description":"Developer REST APIs for Oracle Integration's SFTP-compliant repository for storing and retrieving files.", "version":"2025.10.24", "x-summary":"Developer REST APIs for Oracle Integration's SFTP-compliant repository for storing and retrieving files." }, "servers":[ { "url":"{protocol}//{host}:{port}{basePath}", "description":"File Server gateway base path", "variables":{ "protocol":{ "default":"http:" }, "host":{ "default":"localhost" }, "port":{ "default":"8765" }, "basePath":{ "default":"" } } } ], "tags":[ { "name":"File Server/Configuration" }, { "name":"File Server/File System" }, { "name":"File Server/Groups" }, { "name":"File Server/Services" }, { "name":"File Server/Users" } ], "paths":{ "/ic/api/fileserver/v1/groups/{group}":{ "get":{ "tags":[ "File Server/Groups" ], "summary":"Get Individual Group", "description":"Get one individual group", "operationId":"getGroup", "parameters":[ { "name":"group", "in":"path", "description":"group", "required":true, "schema":{ "type":"string", "description":"Group to be fetched" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerGroup" } } } }, "401":{ "description":"Unauthorized to get group" }, "404":{ "description":"Group Unavailable" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-groups-{group}-get", "x-filename-id":"ic-api-fileserver-v1-groups-group-get" }, "put":{ "tags":[ "File Server/Groups" ], "summary":"Update a Group", "description":"Update a group", "operationId":"updateGroup", "parameters":[ { "name":"group", "in":"path", "description":"group", "required":true, "schema":{ "type":"string", "description":"Group to be updated" } } ], "requestBody":{ "description":"Updated group object", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerGroup" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerGroup" } } } }, "401":{ "description":"Unauthorized to update group details" }, "404":{ "description":"Group Unavailable" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-groups-{group}-put", "x-filename-id":"ic-api-fileserver-v1-groups-group-put" }, "delete":{ "tags":[ "File Server/Groups" ], "summary":"Delete Individual Group", "description":"Delete a group's metadata (for example, permissions and home settings)", "operationId":"deleteGroupMetadata", "parameters":[ { "name":"group", "in":"path", "description":"group", "required":true, "schema":{ "type":"string", "description":"Group to be deleted" } } ], "responses":{ "200":{ "description":"Success" }, "204":{ "description":"No Content, Success" }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-groups-{group}-delete", "x-filename-id":"ic-api-fileserver-v1-groups-group-delete" } }, "/ic/api/fileserver/v1/groups":{ "get":{ "tags":[ "File Server/Groups" ], "summary":"Search Groups", "description":"Search groups by given criteria", "operationId":"getGroups", "parameters":[ { "name":"searchCriteria", "in":"query", "description":"searchCriteria", "required":true, "schema":{ "type":"string", "description":"Search groups having specified name criteria" } }, { "name":"configuredGroupsOnly", "in":"query", "description":"Flag to search for all groups or only configured File Server groups", "schema":{ "type":"boolean", "description":"Flag to search for all groups or only configured File Server groups", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerGroups" } } } }, "401":{ "description":"Unauthorized to get groups" }, "404":{ "description":"Groups unavailable" }, "500":{ "description":"Internal server error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-groups-get", "x-filename-id":"ic-api-fileserver-v1-groups-get" } }, "/ic/api/fileserver/v1/filesystem/configuration":{ "get":{ "tags":[ "File Server/Configuration" ], "summary":"Get File System Configuration", "description":"Rest API to file system configuration", "operationId":"getConfiguration", "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileSystemConfiguration" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Services not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-configuration-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-configuration-get" }, "put":{ "tags":[ "File Server/Configuration" ], "summary":"Update the File System Configuration", "description":"Update file system configuration", "operationId":"updateConfiguration", "requestBody":{ "description":"configuration", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileSystemConfiguration" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileSystemConfiguration" } } } }, "400":{ "description":"Bad request" }, "401":{ "description":"Not authorized to update the configuration" }, "404":{ "description":"Services not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-configuration-put", "x-filename-id":"ic-api-fileserver-v1-filesystem-configuration-put" } }, "/ic/api/fileserver/v1/filesystem/directories":{ "post":{ "tags":[ "File Server/File System" ], "summary":"Create a Folder", "description":"Create a Folder", "operationId":"createDirectory", "requestBody":{ "description":"directoryDO", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Directory" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal server error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-post", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-post" } }, "/ic/api/fileserver/v1/filesystem/root/{fsPath}":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get a Folder by Path", "description":"Get a folder by path", "operationId":"getFileSystem", "parameters":[ { "name":"fsPath", "in":"path", "description":"fsPath", "required":true, "schema":{ "type":"string", "description":"Path of the file system" } }, { "name":"filterPattern", "in":"query", "description":"filterPattern", "required":true, "schema":{ "type":"string", "description":"File name pattern" } }, { "name":"listFiles", "in":"query", "description":"listFiles", "schema":{ "type":"boolean", "description":"Flag to indicate whether to include files in the list", "default":true } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BrowseFileSystem" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-root-{fsPath}-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-root-fspath-get" }, "put":{ "tags":[ "File Server/File System" ], "summary":"Update a Folder by Path", "description":"Update a folder by its path", "operationId":"DirectoryPath", "parameters":[ { "name":"fsPath", "in":"path", "description":"Path", "required":true, "schema":{ "type":"string", "description":"Path of the folder to be updated" } } ], "requestBody":{ "description":"directoryDO", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Directory" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-root-{fsPath}-put", "x-filename-id":"ic-api-fileserver-v1-filesystem-root-fspath-put" }, "delete":{ "tags":[ "File Server/File System" ], "summary":"Delete a Folder by Path", "description":"Delete a folder by path", "operationId":"deleteDirectoryPath", "parameters":[ { "name":"fsPath", "in":"path", "description":"Path", "required":true, "schema":{ "type":"string", "description":"Path of the folder to be deleted" } }, { "name":"recursive", "in":"query", "description":"Flag to indicate whether to delete all subfolders and files recursively. If the folder is not empty and recursive is false, then the operation will fail", "schema":{ "type":"boolean", "description":"Flag to indicate whether to delete all subfolders and files recursively. If the folder is not empty and recursive is false, then the operation will fail", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "length":{ "type":"integer", "format":"int32" }, "language":{ "type":"object", "properties":{ "language":{ "type":"string" }, "script":{ "type":"string" }, "country":{ "type":"string" }, "variant":{ "type":"string" }, "extensionKeys":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "unicodeLocaleAttributes":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "unicodeLocaleKeys":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "iso3Language":{ "type":"string" }, "iso3Country":{ "type":"string" }, "displayLanguage":{ "type":"string" }, "displayScript":{ "type":"string" }, "displayCountry":{ "type":"string" }, "displayVariant":{ "type":"string" }, "displayName":{ "type":"string" } } }, "location":{ "type":"string", "format":"uri" }, "status":{ "type":"integer", "format":"int32" }, "entity":{ "type":"object" }, "metadata":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"object" } } }, "lastModified":{ "type":"string", "format":"date-time" }, "date":{ "type":"string", "format":"date-time" }, "headers":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"object" } } }, "links":{ "uniqueItems":true, "type":"array", "items":{ "type":"object", "properties":{ "type":{ "type":"string" }, "params":{ "type":"object", "additionalProperties":{ "type":"string" } }, "uri":{ "type":"string", "format":"uri" }, "title":{ "type":"string" }, "uriBuilder":{ "type":"object" }, "rels":{ "type":"array", "items":{ "type":"string" } }, "rel":{ "type":"string" } } } }, "cookies":{ "type":"object", "additionalProperties":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "version":{ "type":"integer", "format":"int32" }, "path":{ "type":"string" }, "domain":{ "type":"string" }, "comment":{ "type":"string" }, "maxAge":{ "type":"integer", "format":"int32" }, "expiry":{ "type":"string", "format":"date-time" }, "secure":{ "type":"boolean" }, "httpOnly":{ "type":"boolean" } } } }, "statusInfo":{ "type":"object", "properties":{ "statusCode":{ "type":"integer", "format":"int32" }, "reasonPhrase":{ "type":"string" }, "family":{ "type":"string", "enum":[ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] } } }, "mediaType":{ "type":"object", "properties":{ "type":{ "type":"string" }, "subtype":{ "type":"string" }, "parameters":{ "type":"object", "additionalProperties":{ "type":"string" } }, "wildcardType":{ "type":"boolean" }, "wildcardSubtype":{ "type":"boolean" } } }, "allowedMethods":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "entityTag":{ "type":"object", "properties":{ "value":{ "type":"string" }, "weak":{ "type":"boolean" } } }, "stringHeaders":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"string" } } } } } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal server error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-root-{fsPath}-delete", "x-filename-id":"ic-api-fileserver-v1-filesystem-root-fspath-delete" } }, "/ic/api/fileserver/v1/filesystem/directories/{guid}":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get a Folder by Path ID", "description":"Get a folder by its path ID", "operationId":"getDirectory", "parameters":[ { "name":"guid", "in":"path", "description":"guid", "required":true, "schema":{ "type":"string", "description":"PathID of folder" } }, { "name":"filterPattern", "in":"query", "description":"filterPattern", "required":true, "schema":{ "type":"string", "description":"File name pattern" } }, { "name":"listFiles", "in":"query", "description":"listFiles", "schema":{ "type":"boolean", "description":"Flag to indicate whether to include files in the list", "default":true } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BrowseFileSystem" } } } }, "401":{ "description":"Unauthorized to get path" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-get" }, "put":{ "tags":[ "File Server/File System" ], "summary":"Update a Folder", "description":"Update folder by pathId", "operationId":"updateDirectory", "parameters":[ { "name":"guid", "in":"path", "description":"guid", "required":true, "schema":{ "type":"string", "description":"PathId of the folder to be updated" } } ], "requestBody":{ "description":"Updated directory metadata", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Directory" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-put", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-put" }, "delete":{ "tags":[ "File Server/File System" ], "summary":"Delete a Folder", "description":"Delete a folder by pathId", "operationId":"deleteDirectory", "parameters":[ { "name":"guid", "in":"path", "description":"guid", "required":true, "schema":{ "type":"string", "description":"PathId of the folder to be deleted" } }, { "name":"recursive", "in":"query", "description":"Flag to indicate whether to delete all subdirectories and files recursively. If directory is not empty and recursive is false then operation will fail", "schema":{ "type":"boolean", "description":"Flag to indicate whether to delete all subdirectories and files recursively. If directory is not empty and recursive is false then operation will fail", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "length":{ "type":"integer", "format":"int32" }, "language":{ "type":"object", "properties":{ "language":{ "type":"string" }, "script":{ "type":"string" }, "country":{ "type":"string" }, "variant":{ "type":"string" }, "extensionKeys":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "unicodeLocaleAttributes":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "unicodeLocaleKeys":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "iso3Language":{ "type":"string" }, "iso3Country":{ "type":"string" }, "displayLanguage":{ "type":"string" }, "displayScript":{ "type":"string" }, "displayCountry":{ "type":"string" }, "displayVariant":{ "type":"string" }, "displayName":{ "type":"string" } } }, "location":{ "type":"string", "format":"uri" }, "status":{ "type":"integer", "format":"int32" }, "entity":{ "type":"object" }, "metadata":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"object" } } }, "lastModified":{ "type":"string", "format":"date-time" }, "date":{ "type":"string", "format":"date-time" }, "headers":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"object" } } }, "links":{ "uniqueItems":true, "type":"array", "items":{ "type":"object", "properties":{ "type":{ "type":"string" }, "params":{ "type":"object", "additionalProperties":{ "type":"string" } }, "uri":{ "type":"string", "format":"uri" }, "title":{ "type":"string" }, "uriBuilder":{ "type":"object" }, "rels":{ "type":"array", "items":{ "type":"string" } }, "rel":{ "type":"string" } } } }, "cookies":{ "type":"object", "additionalProperties":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "version":{ "type":"integer", "format":"int32" }, "path":{ "type":"string" }, "domain":{ "type":"string" }, "comment":{ "type":"string" }, "maxAge":{ "type":"integer", "format":"int32" }, "expiry":{ "type":"string", "format":"date-time" }, "secure":{ "type":"boolean" }, "httpOnly":{ "type":"boolean" } } } }, "statusInfo":{ "type":"object", "properties":{ "statusCode":{ "type":"integer", "format":"int32" }, "reasonPhrase":{ "type":"string" }, "family":{ "type":"string", "enum":[ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] } } }, "mediaType":{ "type":"object", "properties":{ "type":{ "type":"string" }, "subtype":{ "type":"string" }, "parameters":{ "type":"object", "additionalProperties":{ "type":"string" } }, "wildcardType":{ "type":"boolean" }, "wildcardSubtype":{ "type":"boolean" } } }, "allowedMethods":{ "uniqueItems":true, "type":"array", "items":{ "type":"string" } }, "entityTag":{ "type":"object", "properties":{ "value":{ "type":"string" }, "weak":{ "type":"boolean" } } }, "stringHeaders":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } }, "additionalProperties":{ "type":"array", "items":{ "type":"string" } } } } } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-delete", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-delete" } }, "/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/groups/{group}":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get Folder Permission for a User", "description":"Get folder permission for a given user", "operationId":"getDirectoryPermissionForGroup", "parameters":[ { "name":"guid", "in":"path", "description":"folder guid", "required":true, "schema":{ "type":"string", "description":"folder guid" } }, { "name":"group", "in":"path", "description":"group name", "required":true, "schema":{ "type":"string", "description":"group name" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PrincipleDirectoryPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-permissions-groups-{group}-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-permissions-groups-group-get" } }, "/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get Folder Permissions", "description":"Get permission entries for a folder", "operationId":"getDirectoryPermission", "parameters":[ { "name":"guid", "in":"path", "description":"PathId", "required":true, "schema":{ "type":"string", "description":"pathId" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DirectoryPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-permissions-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-permissions-get" }, "put":{ "tags":[ "File Server/File System" ], "summary":"Update a Folder's Permissions", "description":"Update a specified folder's permissions", "operationId":"updateDirectoryPermission", "parameters":[ { "name":"guid", "in":"path", "description":"PathId of the folder", "required":true, "schema":{ "type":"string", "description":"PathId of the folder" } } ], "requestBody":{ "description":"directoryPermissionDO", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DirectoryPermission" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DirectoryPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-permissions-put", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-permissions-put" } }, "/ic/api/fileserver/v1/filesystem/root":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get Root Directory of File System", "description":"Get the root directory metadata", "operationId":"getFileSystemRoot", "parameters":[ { "name":"filterPattern", "in":"query", "description":"filterPattern", "required":true, "schema":{ "type":"string", "description":"File name pattern" } }, { "name":"listFiles", "in":"query", "description":"listFiles", "schema":{ "type":"boolean", "description":"Flag to indicate whether to include files in the list", "default":true } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BrowseFileSystem" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-root-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-root-get" } }, "/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/users/{user}":{ "get":{ "tags":[ "File Server/File System" ], "summary":"Get User Permission", "description":"Get folder permissions for a user", "operationId":"getDirectoryPermissionForUser", "parameters":[ { "name":"guid", "in":"path", "description":"folder guid", "required":true, "schema":{ "type":"string", "description":"folder guid" } }, { "name":"user", "in":"path", "description":"user name", "required":true, "schema":{ "type":"string", "description":"user name" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PrincipleDirectoryPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-filesystem-directories-{guid}-permissions-users-{user}-get", "x-filename-id":"ic-api-fileserver-v1-filesystem-directories-guid-permissions-users-user-get" } }, "/ic/api/fileserver/v1/serviceinstance":{ "get":{ "tags":[ "File Server/Services" ], "summary":"Get Service Instance Details", "description":"Get service instance info", "operationId":"getServiceInstanceDetails", "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceInstanceDetails" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-serviceinstance-get", "x-filename-id":"ic-api-fileserver-v1-serviceinstance-get" } }, "/ic/api/fileserver/v1/services":{ "get":{ "tags":[ "File Server/Services" ], "summary":"Get all Services", "description":"List all the available services", "operationId":"getServices", "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Services" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-get", "x-filename-id":"ic-api-fileserver-v1-services-get" } }, "/ic/api/fileserver/v1/services/{serviceType}":{ "get":{ "tags":[ "File Server/Services" ], "summary":"Get Service Status", "description":"Get the status of a specific service", "operationId":"getService", "parameters":[ { "name":"serviceType", "in":"path", "description":"Service type to be fetched", "required":true, "schema":{ "type":"string", "description":"Service type to be fetched" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceStatus" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Embedded Server not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-{serviceType}-get", "x-filename-id":"ic-api-fileserver-v1-services-servicetype-get" }, "put":{ "tags":[ "File Server/Services" ], "summary":"Update a Service", "description":"Update a service's status", "operationId":"updateService", "parameters":[ { "name":"serviceType", "in":"path", "description":"serviceType", "required":true, "schema":{ "type":"string", "description":"Service type to be updated" } } ], "requestBody":{ "description":"serviceStatus", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceStatus" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceStatus" } } } }, "400":{ "description":"Bad request" }, "401":{ "description":"Unauthorized to update the service" }, "404":{ "description":"Embedded Server not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-{serviceType}-put", "x-filename-id":"ic-api-fileserver-v1-services-servicetype-put" } }, "/ic/api/fileserver/v1/services/sftp/configuration":{ "get":{ "tags":[ "File Server/Services" ], "summary":"Get SFTP Server Configuration", "description":"Get SFTP server configuration", "operationId":"getSftpServiceConfiguration", "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SftpServerConfiguration" } } } }, "400":{ "description":"Bad request" }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Configuration not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-sftp-configuration-get", "x-filename-id":"ic-api-fileserver-v1-services-sftp-configuration-get" }, "put":{ "tags":[ "File Server/Services" ], "summary":"Update SFTP Service Configuration", "description":"Update SFTP service configuration", "operationId":"updateSftpServiceConfiguration", "requestBody":{ "description":"sftpServerConfiguration", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SftpServerConfiguration" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SftpServerConfiguration" } } } }, "400":{ "description":"Bad request" }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Configuration not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-sftp-configuration-put", "x-filename-id":"ic-api-fileserver-v1-services-sftp-configuration-put" } }, "/ic/api/fileserver/v1/services/sftp/supportedSecurityAlgorithms":{ "get":{ "tags":[ "File Server/Services" ], "summary":"Get SFTP Security Supported Algorithms", "description":"Get a list of all supported SFTP security algorithms. These can enabled/disabled by the sftp configuration", "operationId":"getSftpSupportedCiphers", "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SftpSupportedSecurityAlgorithms" } } } }, "400":{ "description":"Bad request" }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Configuration not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-services-sftp-supportedSecurityAlgorithms-get", "x-filename-id":"ic-api-fileserver-v1-services-sftp-supportedsecurityalgorithms-get" } }, "/ic/api/fileserver/v1/users/{user}":{ "get":{ "tags":[ "File Server/Users" ], "summary":"Get a User's Details", "description":"Return details for a specified user", "operationId":"getUser", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"Specify the user's ID" } }, { "name":"includeGroupInformation", "in":"query", "description":"Include group information", "schema":{ "type":"boolean", "description":"Include group information", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerUser" } } } }, "401":{ "description":"Unauthorized to get user" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-get", "x-filename-id":"ic-api-fileserver-v1-users-user-get" }, "put":{ "tags":[ "File Server/Users" ], "summary":"Update a User's Details", "description":"Update a specified user's details", "operationId":"updateUser", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"ID of user to be updated" } } ], "requestBody":{ "description":"FileServerUsers", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerUsers" } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerUsers" } } } }, "401":{ "description":"Not authorized to update users" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-put", "x-filename-id":"ic-api-fileserver-v1-users-user-put" }, "delete":{ "tags":[ "File Server/Users" ], "summary":"Delete a User's Metadata", "description":"Delete a user's metadata (permissions and home settings) from File Server. This action does not remove the user from the identity management system.", "operationId":"deleteUserMetadata", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"Specify the user whose metadata is being deleted" } } ], "responses":{ "200":{ "description":"Success" }, "204":{ "description":"No Content, Success" }, "401":{ "description":"Not aauthorized to delete user metadata" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-delete", "x-filename-id":"ic-api-fileserver-v1-users-user-delete" } }, "/ic/api/fileserver/v1/users":{ "get":{ "tags":[ "File Server/Users" ], "summary":"Search for Users", "description":"Search for all users, those configured for File Server, or by group name", "operationId":"getUsers", "parameters":[ { "name":"searchCriteria", "in":"query", "description":"searchCriteria", "required":true, "schema":{ "type":"string", "description":"Specify a group to search for its users" } }, { "name":"configuredUsersOnly", "in":"query", "description":"Search for all users (false) or configured File Server users only", "schema":{ "type":"boolean", "description":"Search for all users or configured File Server users only", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FileServerUsers" } } } }, "401":{ "description":"Not authorized to get users" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-get", "x-filename-id":"ic-api-fileserver-v1-users-get" } }, "/ic/api/fileserver/v1/users/{user}/key":{ "get":{ "tags":[ "File Server/Users" ], "summary":"Get a User's SSH Public Key", "description":"Get a user's SSH public key", "operationId":"getUserKey", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"ID for user for whom public key is being fetched" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/octet-stream":{ "schema":{ "type":"object" } }, "application/json":{ "schema":{ "type":"object" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"User Key not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-key-get", "x-filename-id":"ic-api-fileserver-v1-users-user-key-get" }, "put":{ "tags":[ "File Server/Users" ], "summary":"Update a User's SSH Public Key", "description":"Update a user's SSH public key used for SFTP authentication", "operationId":"updateUserKey", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"ID of the user whose public key is being updated" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "userkey":{ "$ref":"#/components/schemas/FormDataContentDisposition" } } } } } }, "responses":{ "200":{ "description":"Success" }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-key-put", "x-filename-id":"ic-api-fileserver-v1-users-user-key-put" }, "post":{ "tags":[ "File Server/Users" ], "summary":"Upload a User's SSH Public Key", "description":"Upload a user's SSH public key used for SFTP authentication", "operationId":"createUserKey", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"ID of user whose public key is being created" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "userkey":{ "$ref":"#/components/schemas/FormDataContentDisposition" } } } } } }, "responses":{ "200":{ "description":"Success" }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-key-post", "x-filename-id":"ic-api-fileserver-v1-users-user-key-post" }, "delete":{ "tags":[ "File Server/Users" ], "summary":"Delete a User's SSH Public Key", "description":"Delete a user's SSH public key", "operationId":"deleteUserKey", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"ID of user whose public key is being deleted" } } ], "responses":{ "200":{ "description":"Success" }, "204":{ "description":"No Content, Success" }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-key-delete", "x-filename-id":"ic-api-fileserver-v1-users-user-key-delete" } }, "/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root":{ "get":{ "tags":[ "File Server/Users" ], "summary":"Get User's Permissions for Root", "description":"Get a user's permissions for the root folder", "operationId":"getEffectivePermissionforUserForRootDir", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"User for whom permission is evaluated" } }, { "name":"detailed", "in":"query", "description":"flag to send the detailed response including where permissions are derived from", "schema":{ "type":"boolean", "description":"flag to send the detailed response including where permissions are derived from", "default":true } }, { "name":"ignoreCache", "in":"query", "description":"flag to indicate to always recompute", "schema":{ "type":"boolean", "description":"flag to indicate to always recompute", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EffectiveUserPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-effectivepermissions-filesystem-root-get", "x-filename-id":"ic-api-fileserver-v1-users-user-effectivepermissions-filesystem-root-get" } }, "/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root/{fsPath}":{ "get":{ "tags":[ "File Server/Users" ], "summary":"Get User's Permissions", "description":"Get user's permissions for a specified folder", "operationId":"getEffectivePermissionforUserForGivenDir", "parameters":[ { "name":"user", "in":"path", "description":"user", "required":true, "schema":{ "type":"string", "description":"Param user for whom permission is evaluated" } }, { "name":"fsPath", "in":"path", "description":"Path", "required":true, "schema":{ "type":"string", "description":"Param path for which permission is evaluated" } }, { "name":"detailed", "in":"query", "description":"flag to send the detailed response inclding where permissions are derived from", "schema":{ "type":"boolean", "description":"flag to send the detailed response inclding where permissions are derived from", "default":true } }, { "name":"ignoreCache", "in":"query", "description":"flag to indicate to always recompute", "schema":{ "type":"boolean", "description":"flag to indicate to always recompute", "default":false } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EffectiveUserPermission" } } } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Service not found" }, "500":{ "description":"Internal Server Error" } }, "security":[ { "oauth":[ "/ic/api/" ] } ], "x-internal-id":"ic-api-fileserver-v1-users-{user}-effectivepermissions-filesystem-root-{fsPath}-get", "x-filename-id":"ic-api-fileserver-v1-users-user-effectivepermissions-filesystem-root-fspath-get" } } }, "components":{ "schemas":{ "FileServerGroup":{ "type":"object", "properties":{ "name":{ "type":"string" }, "status":{ "type":"string", "description":"Group's status", "enum":[ "not configured", "enabled", "disabled" ] }, "homeType":{ "type":"string", "description":"Home type", "enum":[ "Default", "Custom", "None" ] }, "homeDirectory":{ "type":"string", "description":"Home directory or landing folder for group", "nullable":true } }, "description":"describes group's fileserver metadata", "xml":{ "name":"groupConfig" } }, "FileServerGroups":{ "type":"object", "properties":{ "groups":{ "type":"array", "items":{ "$ref":"#/components/schemas/FileServerGroup" } } }, "description":"Provides group search result", "readOnly":true, "xml":{ "name":"groups" } }, "FileSystemConfiguration":{ "required":[ "Quota" ], "type":"object", "properties":{ "defaultUserHomeRights":{ "type":"array", "description":"Assigned rights to a user's default home folder (/home/users/{user}", "items":{ "type":"string", "description":"Assigned rights to a user's default home folder (/home/users/{user}", "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "defaultGroupHomeRights":{ "type":"array", "description":"Assigned rights to a group's default home folder (/home/groups/{group}", "items":{ "type":"string", "description":"Assigned rights to a group's default home folder (/home/groups/{group}", "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "Quota":{ "$ref":"#/components/schemas/Quota" } }, "description":"Describes a file system configuration", "xml":{ "name":"fileserverConfig" } }, "Quota":{ "required":[ "available", "size", "used" ], "type":"object", "properties":{ "cutoffQuota":{ "type":"number", "description":"Defines a max threshold percentage, above which no further uploads are allowed until files are removed." }, "warningQuota":{ "type":"number", "description":"Defines a warning threshold percentage, indicating that system is nearing its max threshold." }, "used":{ "type":"string", "description":"Current usage", "readOnly":true }, "usedPercentage":{ "type":"number", "description":"Current usage ", "readOnly":true }, "size":{ "type":"string", "description":"Max allocated size of the file system", "readOnly":true }, "available":{ "type":"string", "description":"Available storage", "readOnly":true }, "exceededWarningQuota":{ "type":"boolean", "readOnly":true }, "exceededCutoffQuota":{ "type":"boolean", "readOnly":true } }, "description":"Provides the overall storage usage and thresholds." }, "Directory":{ "required":[ "name", "parent" ], "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the folder", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" } }, "parent":{ "type":"string", "description":"Parent folder path", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" } }, "createdDate":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" } }, "links":{ "type":"array", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" }, "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"directories", "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" } }, "Link":{ "required":[ "href", "rel" ], "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "BrowseFileSystem":{ "required":[ "path" ], "type":"object", "properties":{ "guid":{ "type":"string", "description":"Path id", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem" } }, "path":{ "type":"string", "description":"Directory Path", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem" } }, "createDate":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem" } }, "directories":{ "type":"array", "description":"List of child folders", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory" }, "items":{ "$ref":"#/components/schemas/Directory" } }, "files":{ "type":"array", "description":"List of child files", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" }, "items":{ "$ref":"#/components/schemas/File" } }, "links":{ "type":"array", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem" }, "items":{ "$ref":"#/components/schemas/Link" } } }, "description":"Provides metadata for a specified folder and its child folders/files", "readOnly":true, "xml":{ "name":"filesystem", "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem" } }, "File":{ "required":[ "name", "parent" ], "type":"object", "properties":{ "name":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "parent":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "createdDate":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "lastModifiedDate":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "size":{ "type":"string", "readOnly":true, "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "links":{ "type":"array", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" }, "items":{ "$ref":"#/components/schemas/Link" } } }, "description":"List of child files", "readOnly":true, "xml":{ "name":"files", "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file" } }, "Permission":{ "required":[ "id", "principle", "principleType", "rights" ], "type":"object", "properties":{ "id":{ "type":"string", "readOnly":true }, "principle":{ "type":"string", "description":"Name of user/group" }, "principleType":{ "type":"string", "description":"Principle Type", "enum":[ "user", "group" ] }, "principleEnabled":{ "type":"boolean", "description":"Boolean to indicate if user/group is enabled or not" }, "propagateRightsToSubfolders":{ "type":"boolean", "description":"Boolean to indicate if this permission will be applied to all subfolders" }, "rights":{ "type":"array", "description":"Assigned rights list. 'propagateRightsToSubfolders' indicates if this permission will be applied to all subfolders. 'all' includes all other rights except 'propagateRightsToSubfolders' which is specified separately.", "items":{ "type":"string", "description":"Assigned rights list. 'propagateRightsToSubfolders' indicates if this permission will be applied to all subfolders. 'all' includes all other rights except 'propagateRightsToSubfolders' which is specified separately.", "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "lastUpdatedBy":{ "type":"string" }, "lastModified":{ "type":"string" } }, "description":"Configured permission for given directory for given user/group.", "xml":{ "name":"permissions" } }, "PrincipleDirectoryPermission":{ "type":"object", "properties":{ "id":{ "type":"string" }, "path":{ "type":"string", "description":"Directory for which permission is assigned." }, "pathId":{ "type":"string" }, "doNotInherit":{ "type":"boolean", "description":"Boolean indicating that current folder and child folders will not inherit any permission from its parent folders." }, "permission":{ "$ref":"#/components/schemas/Permission" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "description":"Configured permission for given user/group for given directory.", "nullable":true, "readOnly":true, "xml":{ "name":"principleDirectoryPermission", "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/principleDirectoryPermission" } }, "DirectoryPermission":{ "required":[ "path" ], "type":"object", "properties":{ "path":{ "type":"string", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directorypermission" } }, "doNotInherit":{ "type":"boolean", "description":"Boolean indicating that current folder and child folders will not inherit any permission from its parent folders.", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directorypermission" }, "default":false }, "permissions":{ "type":"array", "description":"A list of permissions assigned for given directory to different users/groups.", "items":{ "$ref":"#/components/schemas/Permission" } }, "links":{ "type":"array", "xml":{ "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directorypermission" }, "items":{ "$ref":"#/components/schemas/Link" } } }, "description":"Describes configured permissions for given directory", "xml":{ "name":"directory", "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directorypermission" } }, "ServiceInstanceDetails":{ "type":"object", "properties":{ "serviceInstanceID":{ "type":"string" }, "fileServerServiceInstancceId":{ "type":"string" }, "active":{ "type":"boolean" }, "storageConnectionDetails":{ "type":"string" } }, "xml":{ "name":"serviceInstanceDetails" } }, "ServiceStatus":{ "type":"object", "properties":{ "serviceType":{ "type":"string", "description":"Service name", "enum":[ "sftp" ] }, "status":{ "type":"string", "description":"Activation Status", "enum":[ "RUNNING", "STOPPED", "STARTING", "SHUTTING DOWN", "FAILED" ] }, "activationError":{ "type":"string", "description":"Activation error description, if service is in FAILD state", "readOnly":true } }, "description":"Describes status of given service.", "xml":{ "name":"services" } }, "Services":{ "type":"object", "properties":{ "services":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceStatus" } } }, "description":"Describes status of all services.", "xml":{ "name":"services" } }, "SFTPConfig":{ "required":[ "authType", "securityConfig" ], "type":"object", "properties":{ "securityConfig":{ "$ref":"#/components/schemas/SecurityConfig" }, "authType":{ "type":"string", "description":"Type of Authentication method(s) supported", "xml":{ "attribute":true }, "default":"password or key", "enum":[ "password", "key", "password or key" ] }, "port":{ "type":"integer", "description":"SFTP server port", "format":"int32", "xml":{ "attribute":true } }, "ip":{ "type":"string", "description":"SFTP server ip", "readOnly":true, "xml":{ "attribute":true } }, "idleTimeout":{ "type":"integer", "description":"SFTP server timeout", "format":"int32", "xml":{ "name":"Idle time in seconds after which server will close the connection if the client does not respond", "attribute":true } } }, "description":"Describes configuration of SFTP server." }, "SecurityConfig":{ "type":"object", "properties":{ "cipherSuites":{ "type":"string", "description":"Comma separated values of all configured Cipher Suites. AllowableValues = {\"aes256-ctr\",\"aes192-ctr\",\"aes128-ctr\"}", "xml":{ "attribute":true } }, "keyExchangeAlgorithms":{ "type":"string", "description":"Comma separated values of all configured Key Exchange algorithms. AllowableValues = {\"diffie-hellman-group-exchange-sha256\",\"diffie-hellman-group14-sha1\"}", "xml":{ "attribute":true } }, "messageAuthenticationAlgorithms":{ "type":"string", "description":"Comma separated values of all configured Message Authentication algorithms. AllowableValues = {\"hmac-sha2-512\",\"hmac-sha2-256\"}", "xml":{ "attribute":true } }, "signatureAlgorithms":{ "type":"string", "description":"Comma separated values of all configured Signature Algorithms. AllowableValues = {\"ssh-rsa\",\"ssh-ed25519\",\"ecdsa-sha2-nistp256\",\"ecdsa-sha2-nistp384\",\"ecdsa-sha2-nistp521\",\"rsa-sha2-256\",\"rsa-sha2-512\"}", "xml":{ "attribute":true } }, "compressionMethods":{ "type":"string", "description":"Comma separated values of all configured Compression Methods. AllowableValues = {\"Zlib\",\"zlib@openssh.com\",\"No Compression\"}", "xml":{ "attribute":true } } } }, "SftpServerConfiguration":{ "required":[ "SFTPConfig" ], "type":"object", "properties":{ "sftpconfig":{ "$ref":"#/components/schemas/SFTPConfig" }, "SFTPConfig":{ "$ref":"#/components/schemas/SFTPConfig" } }, "xml":{ "name":"servicesConfig" } }, "SftpSupportedSecurityAlgorithms":{ "type":"object", "properties":{ "keyExchangeAlgorithms":{ "type":"array", "items":{ "type":"string" } }, "messageAuthenticationAlgorithms":{ "type":"array", "items":{ "type":"string" } }, "signatureAlgorithms":{ "type":"array", "items":{ "type":"string" } }, "compressionMethods":{ "type":"array", "items":{ "type":"string" } }, "CipherSuites":{ "type":"array", "items":{ "type":"string", "xml":{ "name":"CipherSuites" } } } }, "description":"Describes all available security algorithms for SFTP service.", "xml":{ "name":"supportedSecurityAlgorithms" } }, "FileServerUser":{ "type":"object", "properties":{ "name":{ "type":"string", "readOnly":true }, "firstName":{ "type":"string", "readOnly":true }, "middleName":{ "type":"string", "readOnly":true }, "lastName":{ "type":"string", "readOnly":true }, "mailId":{ "type":"string", "readOnly":true }, "status":{ "type":"string", "description":"User's status. 'disabled' users can have permissions set while still being prevented from accessing the server. 'not configured' users will not have any associated permissions or other metadata.", "enum":[ "not configured", "enabled", "disabled" ] }, "homeType":{ "type":"string", "description":"The type of home folder the user has. 'Default' is /home/users/{username}. 'Custom' means use the path specified by homeDirectory. 'None' menas there will not be a home folder created for the user and the landing folder willbe determined by thier group membership.", "enum":[ "Default", "Custom", "None" ] }, "homeDirectory":{ "type":"string", "description":"Home directory or landing folder. Absolute path of the home folder when homeType is not 'None'", "nullable":true }, "effectiveHomeDirectory":{ "type":"string", "description":"Computed home/landing folder. It can be different from homeDirectory when home type is none as user will derive home from one its group.", "readOnly":true }, "userGroups":{ "type":"array", "readOnly":true, "items":{ "type":"string", "readOnly":true } }, "publicKeyConfigured":{ "type":"boolean" } }, "description":"describes user's fileserver metadata", "xml":{ "name":"userConfig" } }, "FileServerUsers":{ "type":"object", "properties":{ "users":{ "type":"array", "items":{ "$ref":"#/components/schemas/FileServerUser" } } }, "description":"Provides user search result", "readOnly":true, "xml":{ "name":"users" } }, "FormDataContentDisposition":{ "type":"object", "properties":{ "type":{ "type":"string" }, "parameters":{ "type":"object", "additionalProperties":{ "type":"string" } }, "fileName":{ "type":"string" }, "creationDate":{ "type":"string", "format":"date-time" }, "modificationDate":{ "type":"string", "format":"date-time" }, "readDate":{ "type":"string", "format":"date-time" }, "size":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } } }, "EffectiveRights":{ "type":"object", "properties":{ "right":{ "type":"string", "description":"Folder right. The type of operations permitted for a folder.", "enum":[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ] }, "derivedFromPermissions":{ "type":"array", "description":"List of configured permission ids from which right was derived", "nullable":true, "items":{ "type":"string", "description":"List of configured permission ids from which right was derived", "nullable":true } } }, "description":"Computed rights" }, "EffectiveUserPermission":{ "type":"object", "properties":{ "userName":{ "type":"string" }, "path":{ "type":"string" }, "userGroups":{ "type":"array", "description":"List of groups user belongs to.", "items":{ "type":"string", "description":"List of groups user belongs to." } }, "rights":{ "type":"array", "items":{ "$ref":"#/components/schemas/EffectiveRights" } }, "permissions":{ "type":"array", "description":"Configured permissions from which rights were derived", "nullable":true, "items":{ "$ref":"#/components/schemas/PrincipleDirectoryPermission" } }, "computedOn":{ "type":"string", "description":"Indicates date when comptutation was last performed. Results are cached for performance reason." } }, "description":"Computed permission for a given user for a given path. In addition to directly assigned permissions, users can also inherit permissions from thier group membership and via default home permission.", "xml":{ "name":"effectivePermission" } } } } }