Jump to

• Request
• Response

Get user's permissions for root

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root

Get a user's permissions for the root folder

Request

Path Parameters

• user(required): string
  user

Query Parameters

• detailed(required): boolean
  flag to send the detailed response including where permissions are derived from

  Default Value: true
• ignoreCache(required): boolean
  flag to indicate to always recompute

  Default Value: false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

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

{
    "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"
    }
}

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.

{
    "type":"array",
    "description":"Configured permissions from which rights were derived",
    "nullable":true,
    "items":{
        "$ref":"#/components/schemas/PrincipleDirectoryPermission"
    }
}

Nested Schema : rights

Type: array

Show Source

• Array of: object EffectiveRights
  Computed rights

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EffectiveRights"
    }
}

Nested Schema : userGroups

Type: array

List of groups user belongs to.

Show Source

• Array of: string
  List of groups user belongs to.

{
    "type":"array",
    "description":"List of groups user belongs to.",
    "items":{
        "type":"string",
        "description":"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.

{
    "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"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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.

{
    "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"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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: [ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]

Show Source

• 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.

{
    "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"
    ]
}

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.

{
    "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"
}

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

{
    "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
    }
}

401 Response

Unauthorized

404 Response

Service not found

500 Response

Internal Server Error

Back to Top