Fortinet black logo

Online Help

Get Event

Copy Link
Copy Doc ID f5cba41d-b79a-11ec-9fd1-fa163e15d75b:473061

Get Event

Description

Get activity events definition from FortiCWP.

URL

/api/v1/event

Method: Get

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String

companyId

<12345>

Integer

Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Sample Request

Request URL

GET https://www.forticwp.com/api/v1/event

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

roleId: 36241

companyId: 8059334

Response Variables

Name

Type

Description

id integer operation ID number of application event
name String Display name of operation of application event
nameEnum String Operation ENUM of application event
value String Aggregation of common events
category String Event type
searchField String Sign of common events and unique application events

Sample Response

[

{

"id":1002,

"name":"Login Success",

"nameEnum":"LOGIN_SUCCESS",

"value":"LOGIN_SUCCESS",

"category":"LOGIN",

"searchField":"subOperationList"

},

{

"id":1003,

"name":"Login Failed",

"nameEnum":"LOGIN_FAILED",

"value":"LOGIN_FAILED",

"category":"LOGIN",

"searchField":"subOperationList"

},

{

"id":1004,

"name":"Attach Role Policy",

"nameEnum":"ATTACH_ROLE_POLICY",

"value":"1004",

"category":"USER",

"searchField":"activity"

}

]

Get Event

Description

Get activity events definition from FortiCWP.

URL

/api/v1/event

Method: Get

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String

companyId

<12345>

Integer

Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Sample Request

Request URL

GET https://www.forticwp.com/api/v1/event

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

roleId: 36241

companyId: 8059334

Response Variables

Name

Type

Description

id integer operation ID number of application event
name String Display name of operation of application event
nameEnum String Operation ENUM of application event
value String Aggregation of common events
category String Event type
searchField String Sign of common events and unique application events

Sample Response

[

{

"id":1002,

"name":"Login Success",

"nameEnum":"LOGIN_SUCCESS",

"value":"LOGIN_SUCCESS",

"category":"LOGIN",

"searchField":"subOperationList"

},

{

"id":1003,

"name":"Login Failed",

"nameEnum":"LOGIN_FAILED",

"value":"LOGIN_FAILED",

"category":"LOGIN",

"searchField":"subOperationList"

},

{

"id":1004,

"name":"Attach Role Policy",

"nameEnum":"ATTACH_ROLE_POLICY",

"value":"1004",

"category":"USER",

"searchField":"activity"

}

]