Get user's permissions
get
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root/{fsPath}
Get user's permissions for a specified folder
Request
Path Parameters
Query Parameters
-
detailed(required): boolean
flag to send the detailed response inclding where permissions are derived fromDefault Value:
true
-
ignoreCache(required): boolean
flag to indicate to always recomputeDefault Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : effectivePermission
Type:
object
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.
Show Source
-
computedOn: string
Indicates date when comptutation was last performed. Results are cached for performance reason.
-
path: string
-
permissions: array
permissions
Configured permissions from which rights were derived
-
rights: array
rights
-
userGroups: array
userGroups
List of groups user belongs to.
-
userName: string
Nested Schema : permissions
Type:
array
Configured permissions from which rights were derived
Show Source
-
Array of:
object principleDirectoryPermission
Read Only:
true
Configured permission for given user/group for given directory.
Nested Schema : userGroups
Type:
array
List of groups user belongs to.
Show Source
-
Array of:
string
List of groups user belongs to.
Nested Schema : principleDirectoryPermission
Type:
object
Read Only:
true
Configured permission for given user/group for given directory.
Show Source
-
doNotInherit: boolean
Boolean indicating that current folder and child folders will not inherit any permission from its parent folders.
-
id: string
-
links: array
links
-
path: string
Directory for which permission is assigned.
-
pathId: string
-
permission: object
permissions
Configured permission for given directory for given user/group.
Nested Schema : permissions
Type:
object
Configured permission for given directory for given user/group.
Show Source
-
id(required): string
Read Only:
true
-
lastModified: string
-
lastUpdatedBy: string
-
principle(required): string
Name of user/group
-
principleEnabled: boolean
Boolean to indicate if user/group is enabled or not
-
principleType(required): string
Allowed Values:
[ "user", "group" ]
Principle Type -
propagateRightsToSubfolders: boolean
Boolean to indicate if this permission will be applied to all subfolders
-
rights(required): array
rights
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.
Nested Schema : rights
Type:
array
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.
Allowed Values:
Show Source
[
"read",
"write",
"list",
"delete",
"createDir",
"deleteDir",
"renameDir",
"propagateRightsToSubfolders",
"all"
]
-
Array of:
string
Allowed Values:
[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]
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.
Nested Schema : EffectiveRights
Type:
object
Computed rights
Show Source
-
derivedFromPermissions: array
derivedFromPermissions
List of configured permission ids from which right was derived
-
right: string
Allowed Values:
[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]
Folder right. The type of operations permitted for a folder.
Nested Schema : derivedFromPermissions
Type:
array
List of configured permission ids from which right was derived
Show Source
-
Array of:
string
List of configured permission ids from which right was derived
401 Response
Unauthorized
404 Response
Service not found
500 Response
Internal Server Error