Fortinet black logo

Online Help

Get Data Security Policy List

Get Data Security Policy List

Description

Return all FortiCASB Data Security Policies and details from Data Protection.

URL

/api/v1/scan/policy/list

Method: Get

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

companyId <Company ID> Integer Company ID of which the business unit is under, can be obtained through Get Resource Map.

roleId

<User ID>

Integer

Login user ID, can be obtained through Get Resource Map.

Sample Request

Request URL

GET https://www.forticasb.com/api/v1/scan/policy/list

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

buid: 6384

service: Salesforce

roleId: 36241

companyId: 62598

Response Variables

Name

Type

Description

name String Data Security Policy name.
category String Category of the policy
code String Policy code for identifying the policy

Sample Response

{

"data": {

"datas": [

{

"selectAllFileTypes": false,

"selectAllAccessPermissions": false,

"selectAllFileActivities": false,

"selectAllSaasApps": true,

"filesAddedWithin": {

"name": "ALL_TIME",

"displayName": "All Time",

"code": 6

},

"customizedPatterns": [],

"permitQuarantine": true,

"notifyUsers": false,

"usersToNotify": [],

"notifyOwners": false,

"fazLog": false,

"startTime": 0,

"changeAccessPermission": false,

"changeAccessPermissionType": 0,

"writeLabels": false,

"id": 1,

"companyId": "62598",

"bizUnitId": 84,

"name": "data_security_test",

"predefined": false,

"enabled": true,

"lastUpdated": 1702402793153

},

{

"selectAllFileTypes": false,

"selectAllAccessPermissions": false,

"selectAllFileActivities": false,

"selectAllSaasApps": true,

"filesAddedWithin": {

"name": "ALL_TIME",

"displayName": "All Time",

"code": 6

},

"customizedPatterns": [],

"permitQuarantine": true,

"notifyUsers": false,

"usersToNotify": [],

"notifyOwners": false,

"fazLog": false,

"startTime": 0,

"changeAccessPermission": false,

"changeAccessPermissionType": 0,

"writeLabels": false,

"id": 35,

"companyId": "62598",

"bizUnitId": 84,

"name": "Default FortiCASB Scan-All Data Protection Policy",

"predefined": true,

"enabled": false,

"lastUpdated": 1699312350281

}

],

"totalPage": 0,

"limit": 0,

"skip": 0,

"totalCount": 2

},

"code": 0,

"msg": "success",

"httpCode": 200

}

Get Data Security Policy List

Description

Return all FortiCASB Data Security Policies and details from Data Protection.

URL

/api/v1/scan/policy/list

Method: Get

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

companyId <Company ID> Integer Company ID of which the business unit is under, can be obtained through Get Resource Map.

roleId

<User ID>

Integer

Login user ID, can be obtained through Get Resource Map.

Sample Request

Request URL

GET https://www.forticasb.com/api/v1/scan/policy/list

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

buid: 6384

service: Salesforce

roleId: 36241

companyId: 62598

Response Variables

Name

Type

Description

name String Data Security Policy name.
category String Category of the policy
code String Policy code for identifying the policy

Sample Response

{

"data": {

"datas": [

{

"selectAllFileTypes": false,

"selectAllAccessPermissions": false,

"selectAllFileActivities": false,

"selectAllSaasApps": true,

"filesAddedWithin": {

"name": "ALL_TIME",

"displayName": "All Time",

"code": 6

},

"customizedPatterns": [],

"permitQuarantine": true,

"notifyUsers": false,

"usersToNotify": [],

"notifyOwners": false,

"fazLog": false,

"startTime": 0,

"changeAccessPermission": false,

"changeAccessPermissionType": 0,

"writeLabels": false,

"id": 1,

"companyId": "62598",

"bizUnitId": 84,

"name": "data_security_test",

"predefined": false,

"enabled": true,

"lastUpdated": 1702402793153

},

{

"selectAllFileTypes": false,

"selectAllAccessPermissions": false,

"selectAllFileActivities": false,

"selectAllSaasApps": true,

"filesAddedWithin": {

"name": "ALL_TIME",

"displayName": "All Time",

"code": 6

},

"customizedPatterns": [],

"permitQuarantine": true,

"notifyUsers": false,

"usersToNotify": [],

"notifyOwners": false,

"fazLog": false,

"startTime": 0,

"changeAccessPermission": false,

"changeAccessPermissionType": 0,

"writeLabels": false,

"id": 35,

"companyId": "62598",

"bizUnitId": 84,

"name": "Default FortiCASB Scan-All Data Protection Policy",

"predefined": true,

"enabled": false,

"lastUpdated": 1699312350281

}

],

"totalPage": 0,

"limit": 0,

"skip": 0,

"totalCount": 2

},

"code": 0,

"msg": "success",

"httpCode": 200

}