GenesysCloud
Fetch audit events to see changes within a Genesys Cloud organization.
Analytics & SIEM · Genesys Cloud
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-eventsis only able to retrieve events from the past 14 days. Ensure both thefrom_dateandto_datecommand arguments are within the last 14 days.
Configuration parameters
url— Server URLcredentials— Client ID (required)insecure— Trust any certificate (not secure)proxy— Use system proxy settingsisFetchEvents— Fetch Eventsservice_names— Service namesmax_fetch— Maximum number of events per service
Commands (1)
-
genesys-cloud-get-eventsRetrieves 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.
## Genesys Cloud Help ### How to obtain OAuth Credentials (Client ID & Secret) The steps below require a user account with Admin access. 1. Log in to **Genesys Cloud** and click the **Admin** tab. 2. On the Admin page, click **OAuth** (under Integrations). 3. On the OAuth page, click **Add client**. 4. In the **App Name** field, enter a descriptive name (e.g., Cortex XSIAM Collector). 5. (Optional) In the **Description** field, enter a description. 6. In the **Grant Types** field, select [**Client Credentials Grant**](https://developer.genesys.cloud/api/rest/authorization/use-client-credentials.html). 7. Click **Next**. 8. In the **Assign Roles** table, enable the toggle for each role required by the XSIAM collector. - Ensure the "**Audits** > **Audit** > **View**" permission is selected. - Update the associated divisions for the roles as required; otherwise, they default to the **Home** Division. - If assigning roles for Genesys Cloud for Salesforce, see also [OAuth client permissions for Genesys Cloud for Salesforce](https://help.mypurecloud.com/articles/oauth-client-permissions-for-genesys-cloud-for-salesforce/). 9. Click **Next**. 10. In the **Token Duration in seconds** field, enter the required duration (the default value of 86400 seconds is generally acceptable). 11. Click **Save**. 12. Store the generated **Client ID** and **Client Secret** in a secure location. 13. Click **Finish** and then **Confirm** to complete the process. 14. Use the **Client ID** and **Client Secret** to configure a new instance of this integration.