Fortinet black logo

Online Help

Get Compliance Policy List

Get Compliance Policy List

Description

Return all FortiCASB Compliance Policies and details of the specified cloud service account.

URL

/api/v1/policy/cList

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

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

GET https://www.forticasb.com/api/v1/policy/cList

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

buid: 6384

service: Office365

companyId: 62598

roleid: 36241

Response Variables

Name

Type

Description

name String Compliance Policy name
policyCategory String Category of the policy
policyId String Policy Id for identifying the policy

Sample Response

[

{

"policyId": 31054,

"name": "HIPAA - Access to EPHI Data",

"service": "OFFICE365",

"description": "Track access to EPHI data",

"type": "HIPAA",

"severity": "Critical",

"enable": true,

"exposure": "",

"threshold": 30,

"interval": 60,

"alert": true,

"lastUpdatedBy": "fcasbdemo@gmail.com",

"lastUpdated": 1631078491154,

"guideline": "Audit Controls (§ 164.312(b))Implement procedural mechanisms that record and examine activity in information systems that contain or use electronic protected health information.",

"enableWorkflow": true,

"workflowSubject": "Policy '%s' added to workflow",

"workflowMessage": "Policy '%s' was added to your workflow. You will be notified when the alert's status changes.",

"enableEmail": false,

"emailSubject": "%s Alert",

"emailMessage": "An event matched '%s'. Please verify sensitive information is not exposed.",

"policyCategory": "compliance",

"regexPattern": ".*",

"receivers": [

"qqin@fortinet.com"

],

"isSelectAllEvents": false,

"isSelectAllUsers": false,

"contentMatching": {

"enable": false,

"fileExtExclusion": false,

"fileSize": 0,

"compressedFileSize": 0,

"filePaths": [

""

],

"filePathsExclusion": false,

"ownersExclusion": false,

"exposureExclusion": false

},

"enableActivityMatching": true,

"enableContentMatching": true,

"allDatapattern": false,

"policyCode": "FC-ACT-047",

"isolateMalwareFile": false,

"storageConfig": {},

"enableCreatorEmail": false

}

]

Get Compliance Policy List

Description

Return all FortiCASB Compliance Policies and details of the specified cloud service account.

URL

/api/v1/policy/cList

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

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

GET https://www.forticasb.com/api/v1/policy/cList

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

buid: 6384

service: Office365

companyId: 62598

roleid: 36241

Response Variables

Name

Type

Description

name String Compliance Policy name
policyCategory String Category of the policy
policyId String Policy Id for identifying the policy

Sample Response

[

{

"policyId": 31054,

"name": "HIPAA - Access to EPHI Data",

"service": "OFFICE365",

"description": "Track access to EPHI data",

"type": "HIPAA",

"severity": "Critical",

"enable": true,

"exposure": "",

"threshold": 30,

"interval": 60,

"alert": true,

"lastUpdatedBy": "fcasbdemo@gmail.com",

"lastUpdated": 1631078491154,

"guideline": "Audit Controls (§ 164.312(b))Implement procedural mechanisms that record and examine activity in information systems that contain or use electronic protected health information.",

"enableWorkflow": true,

"workflowSubject": "Policy '%s' added to workflow",

"workflowMessage": "Policy '%s' was added to your workflow. You will be notified when the alert's status changes.",

"enableEmail": false,

"emailSubject": "%s Alert",

"emailMessage": "An event matched '%s'. Please verify sensitive information is not exposed.",

"policyCategory": "compliance",

"regexPattern": ".*",

"receivers": [

"qqin@fortinet.com"

],

"isSelectAllEvents": false,

"isSelectAllUsers": false,

"contentMatching": {

"enable": false,

"fileExtExclusion": false,

"fileSize": 0,

"compressedFileSize": 0,

"filePaths": [

""

],

"filePathsExclusion": false,

"ownersExclusion": false,

"exposureExclusion": false

},

"enableActivityMatching": true,

"enableContentMatching": true,

"allDatapattern": false,

"policyCode": "FC-ACT-047",

"isolateMalwareFile": false,

"storageConfig": {},

"enableCreatorEmail": false

}

]