Get Document Permission

Description

Get the document file sharing permissions.

URL

/api/v1/profile/document/permission

Method: POST

Request Headers

Key	Value	Type	Description
companyId	<12345>	String	Company ID - Company ID can be obtained through Get Resource Map
Authorization	Bearer <Authorization Token>	String	Authorization credential generated by FortiCWP
filedId	<AZSxyCNg>	String	File ID of the document under monitoring in FortiCWP - File ID can be obtained through the response variable objectId from Get Alert by Filter. When the response variable objectType in the "Get Alert by Filter" API response is of type "Document", the objectId is also the file ID. Other types of objectType cannot use objectId as the file ID.
Content-Type	application/json	String

Sample Request

Request URL	POST https://www.forticwp.com/api/v1/profile/document/permission
Request Header	Authorization: Bearer <Authorization_Token> companyId: 1 Content-Type: application/json fileId: RI6AZSxyCNgfjdJDT7F2OgJNzHgCFmVH2Kz_NxYROxM

Response Variables

Name	Type	Description
data	Array	List of profile document permission data
limit	integer	Maximum number of document file permission in a response page
skip	integer	Indexes in a result set, used to exclude response from the first N items of a resource collection.
totalCount	integer	Total number of document file permission
totalPage	integer	Total pages of document file permission
data.AccessControlInfoList	Array of AccessControlInfo	List of access control info of the profile document
data.sharedLink	Array of String	List of the document shared link
data.isPublic	boolean	Check whether the document has public access
data.shareLevel	String	Share level of the document
data.publicPermissionList	Array of PermissionInfo	Permission information of the document
AccessControlInfo.profileUserId	String	Profile user ID that can access to the document
AccessControlInfo.userName	String	Name of the user that can access the document
AccessControlInfo.userType	String	User type
AccessControlInfo.shareLevel	String	Share level of the user, external or internal
AccessControlInfo.permissionInfos	Array of permissionInfo	Permission information of user
PermissionInfo.profilePermissionId	String	Profile permission ID
PermissionInfo.permissionName	String	Permission name
PermissionInfo.permissionDetail	Array	Collection of user permission
PermissionInfo.profileDocumentExposureId	String	Exposure ID of the profile document

Sample Response

{

"data": [

{

"accessControlInfoList": [],

"sharedLink": [],

"isPublic": false,

"shareLevel": "Private",

"publicPermissionList": []

}

],

"totalPage": 0,

"limit": 0,

"skip": 0,

"totalCount": 0

}