GenesysCloud

Details

ID	`GenesysCloud`
Provider	Genesys
Category	Analytics & SIEM
From Version	8.4.0
Docker Image	`demisto/auth-utils:1.0.0.10133006`
Supported Modules	XSIAM

README

Fetch audit events to see changes within a Genesys Cloud organization.
This integration was integrated and tested with version 2 of the Genesys Cloud Platform API.

Configure Genesys Cloud in Cortex

Parameter	Description	Required
Server URL	Default value is https://api.mypurecloud.com/.	False
Client ID		True
Client Secret		True
Trust any certificate (not secure)		False
Use system proxy settings		False
Fetch Events		False
Service names	Ensure all selected services appear in the audit service mapping information. Possible values are: Architect, PeoplePermissions, ContactCenter, Groups, Telephony, Outbound, Routing, Integrations, AnalyticsReporting.	False
Maximum number of events per service	Default value is 2500.	False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

genesys-cloud-get-events

Retrieves audit events from Genesys Cloud from the past 14 days. This command is intended for development and debugging purposes, as it may produce duplicate events, exceed API request rate limits, and disrupt the fetch events mechanism.

Base Command

genesys-cloud-get-events

Input

Argument Name	Description	Required
should_push_events	If true, the command will create events, otherwise it will only display them. Possible values are: true, false. Default is false.	Optional
service_name	Filter by the Genesys Cloud service name. Possible values are: Architect, PeoplePermissions, ContactCenter, Groups, Telephony, Outbound, Routing, Integrations, AnalyticsReporting.	Required
limit	Maximum number of audit events to return.	Optional
from_date	The start date for retrieving events. Must be within the last 14 days. Default is 1 hour ago.	Optional
to_date	The end date for retrieving events. Must be within the last 14 days. Default is now.	Optional

Context Output

There is no context output for this command.

Limitations

The genesys-cloud-get-events is only able to retrieve events from the past 14 days. Ensure both the from_date and to_date command arguments are within the last 14 days.

Configuration parameters

url — Server URL
credentials — Client ID (required)
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings
isFetchEvents — Fetch Events
service_names — Service names
max_fetch — Maximum number of events per service

Commands (1)

genesys-cloud-get-events
Retrieves audit events from Genesys Cloud from the past 14 days. This command is intended for development and debugging purposes, as it may produce duplicate events, exceed API request rate limits, and disrupt the fetch events mechanism.

Source

GenesysCloud.py GenesysCloud_test.py GenesysCloud.yml GenesysCloud_description.md command_examples.txt

Download History Raw

category: Analytics & SIEM
provider: Genesys
sectionorder:
- Connect
- Collect
commonfields:
  id: GenesysCloud
  version: -1
configuration:
# Connect
- defaultvalue: https://api.mypurecloud.com/
  display: Server URL
  name: url
  required: false
  type: 0
  section: Connect
- display: Client ID
  displaypassword: Client Secret
  name: credentials
  required: true
  type: 9
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  required: false
  type: 8
  section: Connect
- display: Use system proxy settings
  name: proxy
  required: false
  type: 8
  section: Connect
# Collect
- display: Fetch Events
  name: isFetchEvents
  required: false
  type: 8
  section: Collect
- display: Service names
  name: service_names
  options:
  - Architect
  - PeoplePermissions
  - ContactCenter
  - Groups
  - Telephony
  - Outbound
  - Routing
  - Integrations
  - AnalyticsReporting
  defaultvalue: Architect,PeoplePermissions,ContactCenter,Groups,Telephony,Outbound,Routing,Integrations,AnalyticsReporting
  additionalinfo: Ensure all selected services appear in the audit service mapping information.
  required: false
  type: 16
  section: Collect
- display: Maximum number of events per service
  name: max_fetch
  defaultvalue: 2500
  required: false
  type: 0
  section: Collect
description: Fetch audit events to see changes within a Genesys Cloud organization.
display: Genesys Cloud
name: GenesysCloud
script:
  commands:
  - name: genesys-cloud-get-events
    description: Retrieves audit events from Genesys Cloud from the past 14 days. This command is intended for development and debugging purposes, as it may produce duplicate events, exceed API request rate limits, and disrupt the fetch events mechanism.
    arguments:
    - name: should_push_events
      description: If true, the command will create events, otherwise it will only display them.
      auto: PREDEFINED
      defaultValue: 'false'
      predefined:
      - 'true'
      - 'false'
    - name: service_name
      description: Filter by the Genesys Cloud service name.
      auto: PREDEFINED
      predefined:
      - Architect
      - PeoplePermissions
      - ContactCenter
      - Groups
      - Telephony
      - Outbound
      - Routing
      - Integrations
      - AnalyticsReporting
      required: true
    - name: limit
      description: Maximum number of audit events to return.
    - name: from_date
      description: The start date for retrieving events. Must be within the last 14 days.
      defaultValue: "1 hour ago"
    - name: to_date
      description: The end date for retrieving events. Must be within the last 14 days.
      defaultValue: "now"
  dockerimage: demisto/auth-utils:1.0.0.10133006
  isfetchevents: true
  runonce: false
  script: '-'
  subtype: python3
  type: python
marketplaces:
- marketplacev2
- platform
fromversion: 8.4.0
tests:
- No tests (auto formatted)
supportedModules:
- xsiam