Workday Event Collector

Use Workday Event Collector integration to get activity loggings from Workday.

Analytics & SIEM · Workday

Details

IDWorkday Event Collector
ProviderWorkday
CategoryAnalytics & SIEM
From Version8.2.0
Docker Imagedemisto/python3:3.12.13.10404775
Supported ModulesAgentix XSIAM Cloud Posture Security

README

Use Workday Event Collector integration to get activity loggings from Workday.
This integration was integrated and tested with API v1.

This is the default integration for this content pack when configured by the Data Onboarder in Cortex XSIAM.

Configure Workday Event Collector in Cortex

Parameter Description Required
Server URL (e.g. https://WORKDAY-HOST/ccx/api/privacy/v1/TENANT_NAME) REST API Endpoint of Workday server. Can be obtained from View API Clients report in Workday application True
Token endpoint (e.g. https://WORKDAY-HOST/ccx/oauth2/TENANT_NAME/token) Token endpoint of the Workday server. Can be obtained from View API Clients report in Workday application. True
Client ID Copy the Client ID and Secret from the Register API Client for Integrations stage at Workday. True
Client Secret   True
Refresh Token Non-expiry Workday API refresh token. True
Trust any certificate (not secure)   False
Use system proxy settings   False
First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)   False
Max events per fetch The maximum number of audit logs to retrieve for each event type. For more information about event types see the help section. 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.

workday-get-activity-logging


Returns activity loggings extracted from Workday.

Base Command

workday-get-activity-logging

Input

Argument Name Description Required
limit The maximum number of loggings to return.. Default is 1000. Optional
offset The zero-based index of the first object in a response collection. Default is 0. Optional
from_date The date and time of the earliest log entry. The default timezone is UTC/GMT. The time format is “{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z”. Example: “2021-05-18T13:45:14Z” indicates May 18, 2021, 1:45PM UTC. Possible values are: . Required
to_date The time format is “{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z”. Example: “2021-05-18T13:45:14Z” indicates May 18, 2021, 1:45PM UTC. Possible values are: . Required
should_push_events Set this argument to True in order to create events, otherwise the command will only display them. Possible values are: True, False. Default is False.  

Context Output

There is no context output for this command.

Command example

!workday-get-activity-logging limit=4 from_date=2023-04-24T07:00:00Z to_date=2023-04-24T08:00:00Z

Human Readable Output

Activity Logging List

Activity Action Device Type Ip Address Request Time Session Id System Account Target Task Display Name Task Id User Activity Entry Count User Agent
test_action test_device 1.1.1.1 2023-04-24T07:00:00Z test_session_id 123 id: 1234
descriptor: test_descriptor
href: test_href
test_display 1 1234 test_agent
test_action test_device 1.1.1.1 2023-04-24T07:00:00Z test_session_id 123 id: 1234
descriptor: test_descriptor
href: test_href
test_display 2 1234 test_agent
test_action test_device 1.1.1.1 2023-04-24T07:00:00Z test_session_id 123 id: 1234
descriptor: test_descriptor
href: test_href
test_display 3 1234 test_agent
test_action test_device 1.1.1.1 2023-04-24T07:00:00Z test_session_id 123 id: 1234
descriptor: test_descriptor
href: test_href
test_display 4 1234 test_agent

Configuration parameters

  • base_url — Server URL (e.g. https://WORKDAY-HOST/ccx/api/privacy/v1/TENANT-NAME) (required)
  • token_url — Token endpoint (e.g. https://WORKDAY-HOST/ccx/oauth2/TENANT-NAME/token) (required)
  • credentials — Client ID (required)
  • token — (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • first_fetch — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  • max_fetch — Max events per fetch
  • eventFetchInterval — Events Fetch Interval

Commands (1)

  • workday-get-activity-logging

    Returns activity loggings extracted from Workday. Use this command for development and debugging only, as it may produce duplicate events, exceed API rate limits, or disrupt the fetch mechanism.

name: Workday Event Collector
display: Workday Event Collector
description: Use Workday Event Collector integration to get activity loggings from Workday.
category: Analytics & SIEM
provider: Workday
sectionorder:
- Connect
- Collect
commonfields:
  id: Workday Event Collector
  version: -1
configuration:
- name: base_url
  display: Server URL (e.g. https://WORKDAY-HOST/ccx/api/privacy/v1/TENANT-NAME)
  required: true
  defaultvalue:
  type: 0
  additionalinfo: 'REST API Endpoint of Workday server. Can be obtained from View API Clients report in Workday application.'
  section: Connect
- name: token_url
  display: Token endpoint (e.g. https://WORKDAY-HOST/ccx/oauth2/TENANT-NAME/token)
  required: true
  defaultvalue:
  type: 0
  additionalinfo: 'Token endpoint of the Workday server. Can be obtained from View API Clients report in Workday application.'
  section: Connect
- name: credentials
  display: Client ID
  required: true
  defaultvalue:
  type: 9
  additionalinfo: 'Copy the Client ID and Secret from the Register API Client for Integrations stage at Workday.'
  displaypassword: Client Secret
  section: Connect
  hiddenusername: false
- name: token
  required: true
  defaultvalue:
  type: 9
  additionalinfo: 'Non-expiry Workday API refresh token.'
  displaypassword: Refresh Token
  hiddenusername: true
  section: Connect
- name: insecure
  display: Trust any certificate (not secure)
  type: 8
  additionalinfo:
  section: Connect
  advanced: true
  required: false
- name: proxy
  display: Use system proxy settings
  type: 8
  additionalinfo:
  section: Connect
  advanced: true
  required: false
- defaultvalue: 7 days
  display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  name: first_fetch
  type: 0
  section: Collect
  required: false
- additionalinfo: The maximum number of audit logs to retrieve for each event type. Large amount of events can cause performance issues.
  defaultvalue: '3000'
  display: Max events per fetch
  name: max_fetch
  type: 0
  section: Collect
  required: false
- defaultvalue: 1
  display: Events Fetch Interval
  name: eventFetchInterval
  type: 19
  section: Collect
  advanced: true
  required: false
script:
  commands:
  - name: workday-get-activity-logging
    description: Returns activity loggings extracted from Workday. Use this command for development and debugging only, as it may produce duplicate events, exceed API rate limits, or disrupt the fetch mechanism.
    arguments:
    - name: limit
      description: The maximum number of loggings to return.
      defaultValue: 1000
      predefined:
      - ""
    - name: offset
      description: The zero-based index of the first object in a response collection.
      defaultValue: 0
      predefined:
      - ""
    - name: from_date
      description: 'The date and time of the earliest log entry. The default timezone is UTC/GMT. The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC.'
      required: true
      defaultValue: ""
      predefined:
      - ""
    - name: to_date
      description: 'The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC.'
      required: true
      defaultValue: ""
      predefined:
      - ""
    - name: should_push_events
      auto: PREDEFINED
      defaultValue: "false"
      description: If true, the command creates events; otherwise, it only displays them.
      predefined:
        - "true"
        - "false"
      required: false
    outputs: []
  runonce: false
  script: "-"
  type: python
  subtype: python3
  isfetchevents: true
  dockerimage: demisto/python3:3.12.13.10404775
fromversion: 8.2.0
tests:
- No tests (auto formatted)
marketplaces:
- marketplacev2
- platform
supportedModules:
- xsiam