FPS Accounts¶
Overview¶
You can use this API to configure Fraud Protection Services (FPS) accounts and their properties in BIG-IQ.
REST Endpoint: /mgmt/cm/websafe/working-config/accounts¶
Requests¶
GET /mgmt/cm/websafe/working-config/accounts/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
id | string (UUID) | A unique identifier given by the system. |
alertId | string | The identifier of alerts belonging to this account. |
users | array_of_objects | A list of users. |
wsUserName | string | The user name. |
lastSocRuleDownloadDateTime | string | The date and time of the most recent Security Operations Center (SOC) rule download. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
WebSafe_Manager_Deployer | Yes |
ASM_Manager | Yes |
WebSafe_Manager | Yes |
Service_Catalog_Editor | Yes |
WebSafe_Manager_View | Yes |
Service_Catalog_Viewer | Yes |
WebSafe_Manager_Edit | Yes |
Security_Manager | Yes |
POST /mgmt/cm/websafe/working-config/accounts¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
alertId | string | False | The identifier of alerts belonging to this account. |
users | array_of_objects | False | A list of users. |
wsUserName | string | False | The user name. |
lastSocRuleDownloadDateTime | string | False | The date and time of the most recent Security Operations Center (SOC) rule download. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
id | string (UUID) | A unique identifier given by the system. |
alertId | string | The identifier of alerts belonging to this account. |
users | array_of_objects | A list of users |
wsUserName | string | The user name. |
lastSocRuleDownloadDateTime | string | The date and time of the most recent Security Operations Center (SOC) rule download. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
WebSafe_Manager_Deployer | No |
ASM_Manager | No |
WebSafe_Manager | Yes |
Service_Catalog_Editor | No |
WebSafe_Manager_View | No |
Service_Catalog_Viewer | No |
WebSafe_Manager_Edit | Yes |
Security_Manager | Yes |
PUT /mgmt/cm/websafe/working-config/accounts/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
alertId | string | False | The identifier of alerts belonging to this account. |
users | array_of_objects | False | A list of users. |
wsUserName | string | False | The user name. |
lastSocRuleDownloadDateTime | string | False | The date and time of the most recent Security Operations Center (SOC) rule download. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
id | string (UUID) | A unique identifier given by the system |
alertId | string | The identifier of alerts belonging to this account. |
users | array_of_objects | A list of users |
wsUserName | string | The username |
lastSocRuleDownloadDateTime | string | The most recent Security Operations Center (SOC) rule download |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
WebSafe_Manager_Deployer | No |
ASM_Manager | No |
WebSafe_Manager | Yes |
Service_Catalog_Editor | No |
WebSafe_Manager_View | No |
Service_Catalog_Viewer | No |
WebSafe_Manager_Edit | Yes |
Security_Manager | Yes |
PATCH /mgmt/cm/websafe/working-config/accounts/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
alertId | string | False | The identifier of alerts belonging to this account. |
users | array_of_objects | False | A list of users. |
wsUserName | string | False | The user name. |
lastSocRuleDownloadDateTime | string | False | The date and time of the most recent Security Operations Center (SOC) rule download. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
id | string (UUID) | A unique identifier given by the system. |
alertId | string | The identifier of alerts belonging to this account. |
users | array_of_objects | A list of users. |
wsUserName | string | The user name. |
lastSocRuleDownloadDateTime | string | The date and time of the most recent Security Operations Center (SOC) rule download. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
WebSafe_Manager_Deployer | No |
ASM_Manager | No |
WebSafe_Manager | Yes |
Service_Catalog_Editor | No |
WebSafe_Manager_View | No |
Service_Catalog_Viewer | No |
WebSafe_Manager_Edit | Yes |
Security_Manager | Yes |
DELETE /mgmt/cm/websafe/working-config/accounts/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
id | string (UUID) | A unique identifier given by the system. |
alertId | string | The identifier of alerts belonging to this account. |
users | array_of_objects | A list of users. |
wsUserName | string | The user name. |
lastSocRuleDownloadDateTime | string | The date and time of the most recent Security Operations Center (SOC) rule download. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
WebSafe_Manager_Deployer | No |
ASM_Manager | No |
WebSafe_Manager | Yes |
Service_Catalog_Editor | No |
WebSafe_Manager_View | No |
Service_Catalog_Viewer | No |
WebSafe_Manager_Edit | Yes |
Security_Manager | Yes |
Examples¶
GET to get an account¶
To get information for a specific account, send a GET request to the accounts collection and specify the account’s identifier.
GET /mgmt/cm/websafe/working-config/accounts/<id>
Response¶
The response will contain an array of users.
HTTP/1.1 200 OK
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username"
}]
}
POST to create an account¶
To create a new account, send a POST request to the accounts collection and include the account users’ information in the body of the request.
POST /mgmt/cm/websafe/working-config/accounts
The JSON in the body of the POST request may be similar to the following example.
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username"
}],
"lastSocRuleDownloadDateTime": No example value specified
}
Response¶
The response to the POST request may be similar to the following example.
HTTP/1.1 200 OK
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}
PUT to edit an existing account¶
To edit an existing account, send a PUT request to the accounts collection, specify the account’s identifier, and include the modified information in the body of the request.
PUT /mgmt/cm/websafe/working-config/accounts/<id>
The JSON in the body of the PUT request may be similar to the following example.
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}
Response¶
The response to the PUT request may be similar to the following example.
HTTP/1.1 200 OK
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}
PATCH to edit an account¶
To edit an existing account, send a PATCH request to the accounts collection, specify the account’s identifier, and include the modified information in the body of the request.
PATCH /mgmt/cm/websafe/working-config/accounts/<id>
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}
Response¶
The response to the PATCH request may be similar to the following example.
HTTP/1.1 200 OK
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}
DELETE to delete an account¶
To delete an existing account, send a DELETE request to the accounts collection and specify the account’s identifier.
DELETE /mgmt/cm/websafe/working-config/accounts/<id>
Response¶
The response to the DELETE request may be similar to the following example.
HTTP/1.1 200 OK
{
"alertId": "ghy87654",
"users": [{
"wsUserName": "some_username",
}],
"lastSocRuleDownloadDateTime": 4
}