CG Scanning API V2
latest
  • latest
  • v5.0.0-beta1
HomeDocs
HomeDocs
latest
  • latest
  • v5.0.0-beta1
  1. User
  2. User Preferences
  • Getting Started
  • Authentication
  • Common Error Responses
  • Filtering Data
  • Authentication
    • User Confirmation
      • Confirm a User
      • Show confirmation form
    • User Invitation
      • Accept an invitation
      • Pre-Accept invitation check
    • Password Reset
      • Forgot Password
      • Reset Password
    • MFA
      • Check 2fa
      • Send SMS OTP
    • Impersonation
      • Impersonate user
      • Impersonate user
    • Sign in authentication
      POST
    • Sign out authentication
      DELETE
  • Organizations
    • Organization Subscriptions
      • Retrieves all subscriptions of organization
      • Retrieves all active subscriptions of organization
      • Show a subscription of organization
      • 'Update organization's subscription'
      • Assign features to a subscription
      • Revoke features from a subscription
    • Subscribe to a plan
    • List organizations
    • Create Organization
    • List dependent subscriptions
    • Show an organization
    • Update an organization
    • Delete an organization
    • Subscribe an organization to a plan
    • Unsubscribe an organization from a plan
    • Move a user from one organization to another
    • Export all organizations to a CSV file
  • Users
    • List Users
    • Create User
    • Show User
    • Update User
    • Delete a User
    • Create Customer
    • Invite User
    • Resend Confirmation Instructions
    • Import Users
    • Check if a user can be deleted
    • Inherit all the resources from a user
    • Export all users to a CSV file
    • Set partner
    • Unset partner
  • User
    • User 2FA
      • Enable 2FA
      • Verify 2FA installation
      • Disable 2FA
      • Lookup phone number
      • Default 2FA method
    • User Preferences
      • Get users notification preferences
        GET
      • Change users product
        PUT
      • Enable user's event notification preference
        PUT
      • Disable user's event notification preference
        PUT
    • Get current user
      GET
    • Update current user
      PUT
    • Change current user password
      PUT
    • Get current user active plans (Not implemented yet)
      GET
    • Get organization members
      GET
    • Get current user products
      GET
    • Get current organization
      GET
    • Update current organization
      PUT
    • Get subscriptions history
      GET
    • Change users product
      PUT
    • Checks if authorization token is valid
      GET
    • Get current user permissions
      GET
    • Check if the user can be deleted
      GET
    • Transfers all the resources from the user to another user
      PUT
    • Delete my account
      DELETE
  • Targets
    • List targets
    • Create Target
    • Show a target
    • Updates a target
    • Delete a target
    • Delete targets
  • Schedules
    • List Schedules
    • Create Schedule
    • Updates a schedule
    • Show a schedule
    • Delete a schedule
    • Delete schedules
    • Calculate First Time Schedule Date
    • Calculate Next Schedule Dates
  • Scans
    • Scan Hosts
      • List of hosts for a scan
      • Host details for a scan
    • Scan Vulnerabilities
      • List of vulnerabilities for a scan
      • Show vulnerability details
      • Statistics for a scan
    • List scans
    • Create Scan
    • Show a scan
    • Updates a scan
    • Delete a scan
    • Delete scans
    • Start a scan
    • Stop a scan
    • List upcoming scans
    • List recent scans that have been completed
    • List of the running scans
    • Create Scan from Wizard
  • Reports
    • List Reports
    • Show a report
    • Delete a report
    • Delete reports
    • Generates a report file
    • Downloads a report file
    • Check if a report file exists
  • Advanced Reports
    • List Advanced Reports
    • Create an advanced report
    • Show an advanced report
    • Update an advanced report
    • Delete an advanced report
    • Delete advanced reports
    • Generates an advanced report file
    • Downloads an advanced report file
  • Vulnerabilities
    • List of vulnerabilities
    • Vulnerability details
    • Total Vulnerabilities (widget)
    • Top Vulnerabilities (widget)
    • PCI Compliant (widget)
    • AI sessions of Vulnerabilities
    • AI session of Vulnerability
    • Chat history about a given Vulnerability
    • Send prompt about a given Vulnerability
  • Exceptions
    • List Exceptions
    • Create Exception
    • Update Exception
    • Show an exception
    • Delete an exception
    • Show exception details
    • Delete exceptions
    • Activate exceptions
    • Reset exceptions
    • Show the exceptions statistics
  • Scanners
    • List scanners
    • Create scanner
    • Show scanner
    • Update scanner
    • Delete scanner
    • List activated scanners
    • Activate scanner
    • Deactivate scanner
    • Update scanner app type
    • Assign a scanner to an organization
    • Verify a scanner
  • Port Lists
    • List port lists
    • Create a port list
    • Show a port list
    • Update a port list
    • Delete a port list
    • List activated port lists
    • Add a port range to a port list
    • Delete a port range to a port list
    • Activate a port list
    • Deactivate a port list
    • Updates the app_type of a port list
    • Sync the a port lists
  • Subscriptions
  • Hosts
    • List of hosts
    • Host details
    • List of most vulnerable hosts
  • Notifications
    • List Notifications
    • Show a notification
    • Delete a notification
    • Mark as read a notification
    • Mark as seen a notification
    • Mark as read all notifications
    • Mark as seen all notifications
  • Whitelabel
  • Webhooks
    • Deliveries
      • List all deliveries for a webhook
      • Get a delivery for a webhook
    • List all webhooks
    • Create a webhook
    • Show a webhook
    • Update a webhook
    • Delete a webhook
    • Activate a webhook
    • Deactivate a webhook
  • Webhook Events
    • Scan Events
  • Audit
    • Get all events
    • Get event by id
    • Delete event by id
  • Whitelabel Settings
    • Show the white label settings
    • Update white label settings
  1. User
  2. User Preferences

Change users product

PUT
/v2/user/preferences/notifications/{name}
User/User Preferences
Last modified:2024-11-22 19:53:37
Update user notification preferences

Request

Path Params
name
enum<string> 
required
The name of the notification preference
Allowed values:
scan_eventreport_eventexception_eventoverdue_pci_reminder
Body Params application/json
object {0}
Example

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v2/user/preferences/notifications/' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
update preference
Body
object {0}
Examples
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "type": {
                "type": "string",
                "value": "notification_preferences"
              },
              "attributes": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "notification_type": {
                    "type": "string",
                    "value": "scan_event"
                  },
                  "enabled": {
                    "type": "boolean",
                    "example": true
                  },
                  "code": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "nullable": true
                  },
                  "params": {
                    "type": "object",
                    "properties": {
                      "when_status": {
                        "type": "array",
                        "description": "Accepted values: completed, started, stopped, failed",
                        "items": {
                          "type": "string"
                        },
                        "example": "completed"
                      },
                      "if_completed": {
                        "type": "array",
                        "description": "Accepted values: pass, fail",
                        "items": {
                          "type": "string"
                        },
                        "example": [
                          "pass"
                        ]
                      },
                      "if_severity": {
                        "type": "array",
                        "items": {
                          "type": "integer"
                        },
                        "example": [
                          6
                        ]
                      }
                    }
                  },
                  "created_at": {
                    "type": "string",
                    "example": "2024-03-04T13:04:41.814Z"
                  },
                  "updated_at": {
                    "type": "string",
                    "example": "2024-03-04T13:04:41.814Z"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
🟠401Unauthorized
🟠422Parameter Error
Modified at 2024-11-22 19:53:37
Previous
Get users notification preferences
Next
Enable user's event notification preference
Built with