You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Workday][Sign-on] Add Sign-on data stream (#20039)
This PR adds the `sign_on` data stream to the Workday integration, along
with its associated dashboard and visualizations.
Workday fields are mapped to their corresponding ECS fields where
possible.
Test samples were derived from live data samples, which were
subsequently sanitized.
Copy file name to clipboardExpand all lines: packages/workday/_dev/build/docs/README.md
+70-17Lines changed: 70 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,35 +4,36 @@
4
4
5
5
[Workday](https://www.workday.com/en-in/homepage.html) is a cloud-based ERP system that manages business processes and allows organizations to use an integrated application. Workday is a coherent cloud ERP system for financial analysis, analytical solutions, HCM suites, and better business processes.
6
6
7
-
The Workday integration for Elastic collects `Activity Logs`via **API** and visualizes them in Kibana.
7
+
The Workday integration for Elastic collects `Activity` logs via the **Workday API** and `Sign-on` logs via the **Workday Custom Report API**, and visualizes them in Kibana.
8
8
9
9
### Compatibility
10
10
11
-
The Workday integration is compatible with API version **v1**.
11
+
- The **Activity** data stream is compatible with Workday API version **v1**.
12
+
- The **Sign-on** data stream is compatible with Workday Custom Reports exposed via the **Reports as a Service (RaaS)** JSON endpoint (`/ccx/service/customreport2/...?format=json`).
12
13
13
14
### How it works
14
15
15
-
This integration periodically queries the Workday API to retrieve logs.
16
+
-**Activity**: This integration periodically queries the Workday API to retrieve Activity logs.
17
+
-**Sign-on**: This integration periodically downloads a Workday Custom Report (for example, a Sign-on report that lists sign-on records along with their key attributes) and ingests each report row as a single event.
16
18
17
19
## What data does this integration collect?
18
20
19
-
This integration collects log messages of the following type:
21
+
This integration collects log messages of the following types:
20
22
21
-
-`Activity`: Collects [Activity Logs](https://community.workday.com/sites/default/files/file-hosting/restapi/#privacy/v1/get-/activityLogging) logs via Workday API (endpoint: `/activityLogging`).
23
+
-`Activity`: Collects [Activity Logs](https://community.workday.com/sites/default/files/file-hosting/restapi/#privacy/v1/get-/activityLogging) via the Workday API (endpoint: `/activityLogging`).
24
+
-`Sign-on`: Collects sign-on information from a Workday Custom Report via the Workday Reports as a Service (RaaS) JSON endpoint.
22
25
23
26
### Supported use cases
24
27
25
-
Integrating Workday with Elastic gives security and IT teams centralized visibility into **Workday activity logging**, so you can monitor configuration and usage changes, support audits, and investigate suspicious behavior from Kibana.
28
+
Integrating Workday with Elastic gives security and IT teams centralized visibility into **Workday activity logging** and **Workday sign-on data**, so you can monitor configuration and usage changes, track sign-on activity and access patterns, support audits, and investigate suspicious or unusual authentication behavior from Kibana.
26
29
27
-
The **Activity** dashboard summarizes key patterns such as **activity volume over time** and **top actors**, helping you spot unusual spikes and focus on the users and operations that matter.
28
-
29
-
Built-in filters make it easier to narrow events by attributes such as **task**, **system account**, and **IP address**, which supports faster triage and a more consistent investigation workflow across your Workday telemetry.
30
+
The **Activity** dashboard summarizes key patterns such as **activity volume over time** and **top actors**, helping you spot unusual spikes and focus on the users and operations that matter. Built-in filters make it easier to narrow events by attributes such as **task**, **system account**, and **IP address**, which supports faster triage and a more consistent investigation workflow across your Workday telemetry.
30
31
31
32
## What do I need to use this integration?
32
33
33
34
### From Workday
34
35
35
-
#### Collect Workday API credentials
36
+
#### For the Activity data stream
36
37
37
38
##### Enable User Activity Logging
38
39
@@ -43,7 +44,7 @@ Built-in filters make it easier to narrow events by attributes such as **task**,
43
44
44
45
**Note:** Once enabled, Workday records all user activity in a secure tenant database. Activity logging must be enabled before any logs are available for export.
45
46
46
-
#### Create Integration System User (ISU)
47
+
#####Create Integration System User (ISU)
47
48
48
49
1. In the Workday search bar, search for Create Integration System User.
49
50
2. Enter a User Name (for example, ISU_SIEM_Export) and a strong Password.
@@ -54,7 +55,7 @@ Built-in filters make it easier to narrow events by attributes such as **task**,
54
55
7. Search for View Domain and locate the User Activity Logging domain. Grant Get access to the ISU security group for this domain.
55
56
8. Search for Activate Pending Security Policy Changes and activate the changes.
56
57
57
-
#### Register API client for OAuth
58
+
#####Register API client for OAuth
58
59
59
60
1. In the Workday search bar, search for Register API Client for Integrations.
60
61
2. Enter a Client Name (for example, SIEM_OAuth_Client).
@@ -69,7 +70,7 @@ Built-in filters make it easier to narrow events by attributes such as **task**,
69
70
9. Generate a new refresh token for the API client.
70
71
10. Copy and save the Refresh Token.
71
72
72
-
#### Determine tenant URL
73
+
#####Determine tenant URL
73
74
74
75
The API endpoint is based on your Workday tenant. The format is:
75
76
@@ -83,6 +84,43 @@ Activity Logging API | https://HOST/ccx/api/privacy/v1/TENANT/activityLogging
83
84
84
85
**Note:** For additional Workday API security context, see [Generating API Keys for the Workday API](https://workday.my.site.com/customercenter/article?no=000013105&redirect=false).
85
86
87
+
#### For the Sign-on data stream
88
+
89
+
##### Build the Sign-on custom report
90
+
91
+
1. Sign in to your Workday tenant as a user with report-authoring privileges.
92
+
2. In the Workday search bar, search for **Create Custom Report**.
93
+
3. Create an Advanced report on a data source that exposes sign-on activity (for example, `Signons and Attempted Signons`).
94
+
4. Add the columns required for sign-on analytics (for example, `System Account`, `Session Start`, `Session End`, `Authentication Type for Signon`, `Failed Signon`, `Invalid Credentials`, `Account Locked, Disabled or Expired`, `Browser Type`, `Operating System`, `Device Type`, `Request Originator`, `SAML Identity Provider`).
95
+
5. On the **Advanced** tab, select **Enable As Web Service** so the report is exposed as Reports as a Service (RaaS).
96
+
6. Save the report and note the **Report Name** and the **Report Owner** (the Workday account that owns the report).
97
+
98
+
##### Create the Integration System User (ISU)
99
+
100
+
1. In the Workday search bar, search for **Create Integration System User**.
101
+
2. Enter a User Name (for example, `ISU_SIEM_Export`) and a strong Password.
102
+
3. Clear the **Require New Password at Next Sign In** checkbox.
103
+
4. Click **OK**.
104
+
5. Search for **Create Security Group** and create an Integration System Security Group (Unconstrained).
105
+
6. Add the ISU (`ISU_SIEM_Export`) to this security group.
106
+
7. Grant the ISU security group access to the domain protecting the custom report's data source (for example, the `System Auditing` domain).
107
+
8. Search for **Activate Pending Security Policy Changes** and activate the changes.
108
+
109
+
##### Determine the report URL
110
+
111
+
The Custom Report endpoint URL has the following format:
-`REPORT_OWNER` is the Workday account that owns the custom report.
122
+
-`REPORT_NAME` is the name of the custom report you created above.
123
+
86
124
## How do I deploy this integration?
87
125
88
126
This integration supports both Elastic Agentless-based and Agent-based installations.
@@ -105,7 +143,7 @@ Elastic Agent must be installed. For more details, check the Elastic Agent [inst
105
143
4. Select **Add Workday** to add the integration.
106
144
5. Enable and configure only the collection methods which you will use.
107
145
108
-
* To **Collect Workday logs via API**, you'll need to:
146
+
* To **Collect Workday Activity logs via API**, you'll need to:
109
147
110
148
- Configure **Hostname**.
111
149
- Configure **Tenant**.
@@ -114,6 +152,12 @@ Elastic Agent must be installed. For more details, check the Elastic Agent [inst
114
152
- Configure **Refresh Token**.
115
153
- Adjust the integration configuration parameters if required, including the **Interval**, **Initial Interval**, **Preserve original event** etc. to enable data collection.
116
154
155
+
* To **Collect Workday Sign-on logs via Custom Report API**, you'll need to:
156
+
157
+
- Configure **Report URL** with the full Workday Custom Report (RaaS) URL noted above.
158
+
- Configure **Username** and **Password** for basic authentication against the Workday Custom Report API.
159
+
- Adjust the integration configuration parameters if required, including the **Interval** and **Preserve original event** etc. to enable data collection.
160
+
117
161
6. Select **Save and continue** to save the integration.
118
162
119
163
### Validation
@@ -140,6 +184,10 @@ For more information on architectures that can be used for scaling this integrat
140
184
141
185
{{fields "activity"}}
142
186
187
+
#### Sign-on
188
+
189
+
{{fields "sign_on"}}
190
+
143
191
### Example event
144
192
145
193
#### Activity
@@ -148,12 +196,17 @@ For more information on architectures that can be used for scaling this integrat
-**Activity**: [Workday Activity API documentation](https://community.workday.com/sites/default/files/file-hosting/restapi/#privacy/v1/get-/activityLogging).
208
+
-**Sign-on**: The Workday **Reports as a Service (RaaS)** JSON endpoint is used to fetch a user-defined Sign-on custom report:
158
209
159
-
**Activity**: [Workday Activity API documentation](https://community.workday.com/sites/default/files/file-hosting/restapi/#privacy/v1/get-/activityLogging).
210
+
```
211
+
GET https://HOST/ccx/service/customreport2/TENANT/REPORT_OWNER/REPORT_NAME?format=json
{"Account_Locked__Disabled_or_Expired":"0","Active_Session":"0","Authentication_Type_for_Signon":"SAML","Browser_Type":"Chrome","Device_Type":"Desktop","Device_is_Trusted":"0","Failed_Signon":"0","Forgotten_Password_Reset_Request":"0","Invalid_Credentials":"0","Is_Device_Managed":"0","Operating_System":"Mac OS X","Password_Changed":"0","Request_Originator":"UI","SAML_Identity_Provider":"IdP_Acme","Session_End":"2026-06-18T23:25:22-07:00","Session_Start":"2026-06-18T16:59:32-07:00","System_Account":"user534.acme / User 534"}
{"Account_Locked__Disabled_or_Expired":"0","Active_Session":"0","Authentication_Failure_Message":"Mobile PIN has expired. To reset your PIN, first sign in using your user name and password.","Authentication_Type_for_Signon":"Biometric","Browser_Type":"Workday Phone App","Device_Type":"Phone","Device_is_Trusted":"0","Failed_Signon":"1","Forgotten_Password_Reset_Request":"0","Invalid_Credentials":"0","Is_Device_Managed":"0","Operating_System":"iOS","Password_Changed":"0","Request_Originator":"UI","Session_Start":"2026-06-18T16:52:43-07:00","System_Account":"user179.acme / User 179","UI_Client_Type":"iPhone Native"}
4
+
{"Account_Locked__Disabled_or_Expired":"0","Active_Session":"0","Authentication_Type_for_Signon":"SAML","Browser_Type":"Workday Phone App","Device_Type":"Phone","Device_is_Trusted":"0","Failed_Signon":"0","Forgotten_Password_Reset_Request":"0","Invalid_Credentials":"0","Is_Device_Managed":"0","Operating_System":"iOS","Password_Changed":"0","Request_Originator":"UI","SAML_Identity_Provider":"IdP_Acme","Session_End":"2026-06-18T22:59:33-07:00","Session_Start":"2026-06-18T16:57:04-07:00","System_Account":"user179.acme / User 179"}
5
+
{"Account_Locked__Disabled_or_Expired":"0","Active_Session":"1","Authentication_Type_for_Signon":"User Name Password","Device_is_Trusted":"0","Failed_Signon":"0","Forgotten_Password_Reset_Request":"0","Invalid_Credentials":"0","Is_Device_Managed":"0","Password_Changed":"0","Request_Originator":"Web Services","Session_Start":"2026-06-18T13:18:51-07:00","System_Account":"ISU_Integration_001"}
6
+
{"Authentication_Type":"SAML","Browser_Type":"Chrome","Created_Moment":"2026-06-22T01:08:10.374-07:00","Device_Type":"Desktop","Device_is_Trusted":"0","Operating_System":"Mac OS X","Prompt_-_Positive_Integer":"linda.andersson / Linda Andersson","Request_Originator":"UI","SAML_Identity_Provider":"Okta E2","Session_ID":"4562a3","Sign-on_Time":"2026-06-22T01:08:10-07:00","Signoff_Time":"2026-06-22T02:09:01-07:00","Signon_IP_Address":"81.2.69.142","Signon_Worker":"Linda Andersson (006193)","User_Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/149.0.0.0 Safari/537.36","userName":"linda.andersson"}
7
+
{"Authentication_Type":"User Name Password","Browser_Type":"Chrome","Created_Moment":"2026-06-22T00:44:17.617-07:00","Device_Type":"Desktop","Device_is_Trusted":"0","Operating_System":"Mac OS X","Prompt_-_Positive_Integer":"alina.goajga / Alina Garagancea","Request_Originator":"UI","Session_ID":"b40162","Sign-on_Time":"2026-06-22T00:44:17-07:00","Signoff_Time":"2026-06-22T03:35:15-07:00","Signon_IP_Address":"81.2.69.144","Signon_Worker":"Alina Garagancea (002036)","User_Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/149.0.0.0 Safari/537.36","userName":"alina.goajga"}
{"Authentication_Failure_Message":"Invalid password","Authentication_Type":"User Name Password","Browser_Type":"Chrome","Created_Moment":"2026-06-22T06:41:11.320-07:00","Device_Type":"Desktop","Device_is_Trusted":"0","Operating_System":"Mac OS X","Prompt_-_Positive_Integer":"chris.carnes / Chris Carnes","Request_Originator":"UI","Sign-on_Time":"2026-06-22T06:41:11-07:00","Signon_IP_Address":"175.16.199.1","Signon_Worker":"Chris Carnes (006423)","User_Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/149.0.0.0 Safari/537.36","userName":"chris.carnes"}
0 commit comments