Post Document Profile Summary
Description
Return all document profile summaries of the specified cloud service account.
URL
/api/v1/profile/document/summary
Method: Post
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCASB |
| Content-Type | application/json | String | |
|
buId |
<Business Unit ID> |
Long |
The targeted business unit ID on FortiCASB. Business unit ID can be obtained through . Alternatively, it can also be obtained from the REST API Get Resource Map |
|
service |
<Salesforce> |
String |
Cloud service account |
|
roleId |
<User ID> |
Integer |
Login user ID, can be obtained through Get Resource Map. |
| companyId | <Company ID> | Integer | Company ID of which the business unit is under, can be obtained through Get Resource Map. |
Sample Request
|
Request URL |
POST https://www.forticasb.com/api/v1/profile/document/summary |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json buid: 6384 service: Office365 companyId: 62598 roleid: 36241 |
|
Request Body |
{ "limit": 10, "skip": 0, "filterDataList": [ { "name": "File Type", "valueList": [] }, { "name": "Sensitive Data", "valueList": [], "byOthers": false, "byAll": false }, { "name": "Share Type", "valueList": [], "byOthers": false, "byAll": false } ] } |
Response Variables
|
Name |
Type |
Description |
|---|---|---|
| name | String | Data type of the file. |
| bubbleList | String | List of file types in the bubble diagram. |
| id | String | The id of the file type. |
Sample Response
{
"data": [
{
"name": "File Type",
"bubbleOther": {
"name": "Non-Extension",
"id": "Non-Extension",
"size": 1
},
"bubbleTotal": {
"name": "With-Extension",
"id": "With-Extension",
"size": 20198
},
"bubbleList": [
{
"name": "7z_014tix27s33cczubi4vbhzeeq3kspwwqpa",
"id": "7z_014TIX27S33CCZUBI4VBHZEEQ3KSPWWQPA",
"size": 2
},
{
"name": "exe_014tix27q4xmeysomhibdzllu3s7z65piw",
"id": "exe_014TIX27Q4XMEYSOMHIBDZLLU3S7Z65PIW",
"size": 2
},
]
},
{
"name": "Sensitive Data",
"bubbleOther": {
"name": "Non-Extension",
"id": "Non-Extension",
"size": 0
},
"bubbleTotal": {
"name": "With-Extension",
"id": "With-Extension",
"size": 80545
},
"bubbleList": [
{
"name": "DLP US WA-1 Driver License Pattern",
"id": "1545",
"size": 1
}
]
},
{
"name": "Share Type",
"bubbleOther": {
"name": "Non-Extension",
"id": "Non-Extension",
"size": 0
},
"bubbleTotal": {
"name": "With-Extension",
"id": "With-Extension",
"size": 15427
},
"bubbleList": [
{
"name": "Anyone Edit Link",
"id": "OFFICE365_LINK_ALL_EDIT",
"size": 1
}
]
},
{
"name": "SaaS App",
"bubbleOther": {
"name": "Non-Extension",
"id": "Non-Extension",
"size": 0
},
"bubbleTotal": {
"name": "With-Extension",
"id": "With-Extension",
"size": 20199
},
"bubbleList": [
{
"name": "Office365",
"id": "OFFICE365",
"size": 20199
}
]
}
],
"code": 0,
"msg": "success",
"httpCode": 200
}