Workday
Workday offers enterprise-level software solutions for financial management, human resources, and planning.
Authentication & Identity Management · Workday
Details
| ID | Workday |
|---|---|
| Provider | Workday |
| Category | Authentication & Identity Management |
| From Version | 5.0.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Supported Modules | Agentix XSIAM Cloud Posture Security |
README
Workday offers enterprise-level software solutions for financial management, human resources, and planning.
This integration was integrated and tested with version 34.0 of Workday
Configure Workday in Cortex
| Parameter | Description | Required |
|---|---|---|
| base_url | Server URL (e.g. https://example.net) | True |
| username | Username | True |
| password | Password | True |
| tenant_name | Tenant name | True |
| token | Token | True |
| insecure | Trust any certificate (not secure) | False |
| proxy | Use system proxy settings | 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-list-workers
List workers command - Returns information for specified workers.
Base Command
workday-list-workers
Input
| Argument Name | Description | Required |
|---|---|---|
| employee_id | Employee ID of the worker for which to get information. | Optional |
| count | The maximum number of results to return. (default = 50) | Optional |
| page | The page from which to get the employees data. (default = 1) | Optional |
| managers | Number of managers to show. (default = 3) | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| Workday.Worker.Worker_ID | String | The ID for the employee or contingent worker. |
| Workday.Worker.User_ID | String | Text attribute identifying User Name. |
| Workday.Worker.Country | String | The worker Country. |
| Workday.Worker.Legal_First_Name | String | The First Name (Given Name) for a worker. |
| Workday.Worker.Legal_Last_Name | String | The Last Name (Family Name) for a worker. |
| Workday.Worker.Preferred_First_Name | String | The First Name (Preferred Name) for a worker. |
| Workday.Worker.Preferred_Last_Name | String | The Last Name (Preferred Name) for a worker. |
| Workday.Worker.Position_ID | String | Text attribute identifying Position ID. |
| Workday.Worker.Position_Title | String | Text attribute identifying Position Title. |
| Workday.Worker.Business_Title | String | Business title for the position. |
| Workday.Worker.Start_Date | String | Date the Worker first started work in this Position. |
| Workday.Worker.End_Employment_Reason_Reference | String | Termination/End Additional Job Reason. |
| Workday.Worker.Worker_Type | String | The worker type for the position. |
| Workday.Worker.Position_Time_Type | String | Position time type. |
| Workday.Worker.Scheduled_Weekly_Hours | String | Scheduled Weekly Hours for Position. |
| Workday.Worker.Default_Weekly_Hours | String | Standard Weekly Hours for Position. |
| Workday.Worker.Full_Time_Equivalent_Percentage | String | Full Time Equivalent Percentage for Position. |
| Workday.Worker.Exclude_from_Headcount | String | If Y, the position will be excluded from headcount reporting. |
| Workday.Worker.Pay_Rate_Type | String | Pay rate type for the position. |
| Workday.Worker.Job_Profile_Name | String | The name of the job profile. |
| Workday.Worker.Work_Shift_Required | String | Returns true if a work shift is required on the position where this job profile is used. |
| Workday.Worker.Critical_Job | String | Returns true if the job profile is considered a critical job. |
| Workday.Worker.Business_Site_id | String | Business Site ID. |
| Workday.Worker.Business_Site_Name | String | The name of the location. |
| Workday.Worker.Business_Site_Type | String | The type of a location. |
| Workday.Worker.Business_Site_Address.Address_ID | String | Business site address ID. |
| Workday.Worker.Business_Site_Address.Formatted_Address | String | The formatted address in the format specified for the country. |
| Workday.Worker.Business_Site_Address.Country | String | Country for the address. |
| Workday.Worker.Business_Site_Address.Postal_Code | String | The postal code part of the address. |
| Workday.Worker.End_Date | String | The effective date of the end employment business process. |
| Workday.Worker.Pay_Through_Date | String | The pay through date for the end of employment. |
| Workday.Worker.Active | String | Boolean attribute identifying whether the Worker is Active. |
| Workday.Worker.Hire_Date | String | The most recent hire date for the employee or contract start date for the contingent worker. |
| Workday.Worker.Hire_Reason | String | Reason for Hire from the most recent Hire event. |
| Workday.Worker.First_Day_of_Work | String | First Day of Work only applies to the Payroll web service. |
| Workday.Worker.Retired | String | Boolean attribute identifying whether the Worker is currently retired. |
| Workday.Worker.Days_Unemployed | String | Number of days unemployed since the employee first joined the work force. Used only for China. |
| Workday.Worker.Terminated | String | Boolean attribute identifying whether the Worker is currently Terminated. |
| Workday.Worker.Termination_Date | String | Most recent Termination Date. |
| Workday.Worker.Primary_Termination_Reason | String | The primary reason for the worker’s most recent termination. |
| Workday.Worker.Primary_Termination_Category | String | Reference to primary termination reason category. |
| Workday.Worker.Termination_Involuntary | String | Indicates if the termination was involuntary. |
| Workday.Worker.Rehire | String | Returns “Yes” if the worker is a rehire based on the most recent hire event. |
| Workday.Worker.Termination_Last_Day_of_Work | String | Last day worked for the worker’s termination event. |
| Workday.Worker.Resignation_Date | String | Date the employee submitted their resignation. |
| Workday.Worker.Has_International_Assignment | String | Indicates whether the worker has internaitonal assignment |
| Workday.Worker.Home_Country_Reference | String | Contains the home country for worker’s primary job (ISO_3166-1_Alpha-2_Code). |
| Workday.Worker.Photo | String | Worker’s photo in base64. |
| Workday.Worker.Addresses.Address_ID | String | Worker’s address ID. |
| Workday.Worker.Addresses.Formatted_Address | String | the formatted address in the format specified for the country. |
| Workday.Worker.Addresses.Country | String | Country for the Worker’s address. |
| Workday.Worker.Addresses.Region | String | The ID of the region (ISO_3166-2_Code) |
| Workday.Worker.Addresses.Region_Descriptor | String | The region part of the address. Typically this contains the state/province information. |
| Workday.Worker.Addresses.Postal_Code | String | The postal code part of the address. |
| Workday.Worker.Addresses.Type | String | Address type. |
| Workday.Worker.Emails.Email_Address | String | Email Address Information. |
| Workday.Worker.Emails.Type | String | Usage type. |
| Workday.Worker.Emails.Primary | String | Indicates if the communication method is primary. |
| Workday.Worker.Emails.Public | String | Indicates if the Email is public. |
| Workday.Worker.Phones.ID | String | Phone ID. |
| Workday.Worker.Phones.Phone_Number | String | Phone number. |
| Workday.Worker.Phones.Type | String | Phone Device Type. |
| Workday.Worker.Phones.Usage | String | Phone usage data. |
| Workday.Worker.Manager.Manager_ID | String | The manager worker ID. |
| Workday.Worker.Manager.Manager_Name | String | The manager name. |
Command Example
!workday-list-workers employee_id=123456
or
!workday-list-workers page=1 count=1 managers=3
Context Example
{
"Workday": {
"Worker": {
"Active": "1",
"Addresses": [
{
"Address_ID": "ADDRESS_REFERENCE-3-3415",
"Country": "SA",
"Formatted_Address": "Kingdom Tower
P.O Box: 230 888, Floor 28
Offices 1431, 1435, 1428, 1429
Riyadh 11321
Riyadh
Saudi Arabia",
"Postal_Code": "112345",
"Region": "01",
"Region_Descriptor": "Riyadh",
"Type": "WORK"
},
{
"Address_ID": "ADDRESS_REFERENCE-6-107",
"Country": "SA",
"Formatted_Address": "King Testname District
Riyadh 13215
Saudi Arabia",
"Postal_Code": "112345",
"Region": "",
"Region_Descriptor": "",
"Type": "HOME"
}
],
"Business_Site_Address": {
"Address_ID": "ADDRESS_REFERENCE-3-3415",
"Country": "SA",
"Formatted_Address": "Kingdom Tower
P.O Box: 230 888, Floor 28
Offices 1431, 1435, 1428, 1429
Riyadh 11321
Riyadh
Saudi Arabia",
"Postal_Code": "112345"
},
"Business_Site_Name": "Office - Saudi Arabia - Riyadh",
"Business_Site_Type": "Office",
"Business_Site_id": "3010",
"Business_Title": "Regional Sales Manager",
"Country": "AE",
"Critical_Job": "0",
"Days_Unemployed": "0",
"Default_Weekly_Hours": "40",
"Emails": [
{
"Email_Address": "test@hotmail.com",
"Primary": true,
"Public": false,
"Type": "HOME"
},
{
"Email_Address": "test@paloaltonetworks.com",
"Primary": true,
"Public": true,
"Type": "WORK"
}
],
"End_Date": null,
"End_Employment_Reason_Reference": "",
"Exclude_from_Headcount": "0",
"First_Day_of_Work": "2020-03-25",
"Full_Time_Equivalent_Percentage": "100",
"Has_International_Assignment": "0",
"Hire_Date": "2020-03-25",
"Hire_Reason": "Hire_Employee_Hire_Employee_Rehire",
"Home_Country_Reference": "SA",
"Job_Profile_Name": "Regional Sales Manager (DQC)",
"Legal_First_Name": "Test_name",
"Legal_Last_Name": "Test_last_name",
"Managers": [
{
"Manager_ID": "100002",
"Manager_Name": "manager_name_3"
},
{
"Manager_ID": "100001",
"Manager_Name": "manager_name_2"
},
{
"Manager_ID": "100000",
"Manager_Name": "manager_name_1"
}
],
"Pay_Rate_Type": "Salary",
"Pay_Through_Date": null,
"Phones": [
{
"ID": "PHONE_REFERENCE-3-4210",
"Phone_Number": "5-5501-2343",
"Type": "Mobile",
"Usage": "WORK"
},
{
"ID": "PHONE_REFERENCE-3-14614",
"Phone_Number": "55501234",
"Type": "Mobile",
"Usage": "HOME"
}
],
"Photo": "image_in_base64",
"Position_ID": "POS-114061",
"Position_Time_Type": "Full_time",
"Position_Title": "Regional Sales Manager",
"Preferred_First_Name": "Test_name",
"Preferred_Last_Name": "Test_last_name",
"Rehire": "1",
"Resignation_Date": "2018-06-14",
"Retired": "0",
"Scheduled_Weekly_Hours": "40",
"Start_Date": "2020-03-25",
"Terminated": "0",
"User_ID": "test@paloaltonetworks.com",
"Work_Shift_Required": "0",
"Worker_ID": "123456",
"Worker_Type": "Regular"
}
}
}
Human Readable Output
Workers
Worker_ID User_ID Country Preferred_First_Name Preferred_Last_Name Active Position_Title Business_Title Start_Date Terminated 123456 test@paloaltonetworks.com AE Test_name Test_last_name 1 Regional Sales Manager Regional Sales Manager 2020-03-25 0
Configuration parameters
base_url— Server URL (e.g. https://example.net) (required)credentials— Username (required)tenant_name— Tenant namecred_tenant_name—token— Tokencred_token—insecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (1)
-
workday-list-workersReturns information for the specified workers.
category: Authentication & Identity Management provider: Workday commonfields: id: Workday version: -1 configuration: - defaultvalue: https://wd5-impl-services1.workday.com/ccx/service display: Server URL (e.g. https://example.net) name: base_url required: true type: 0 - display: Username name: credentials required: true type: 9 - display: Tenant name name: tenant_name type: 4 hidden: true required: false - displaypassword: Tenant name name: cred_tenant_name type: 9 hiddenusername: true required: false - display: Token name: token type: 4 hidden: true required: false - displaypassword: Token name: cred_token type: 9 hiddenusername: true required: false - display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Use system proxy settings name: proxy type: 8 required: false description: Workday offers enterprise-level software solutions for financial management, human resources, and planning. display: Workday name: Workday script: commands: - arguments: - description: Employee ID of the worker for which to get information. name: employee_id - defaultValue: "50" description: The maximum number of results to return. Default is 50. name: count - defaultValue: "1" description: The page from which to get the employees' data. name: page - defaultValue: "3" description: The number of managers to display. name: managers description: Returns information for the specified workers. name: workday-list-workers outputs: - contextPath: Workday.Worker.Worker_ID description: The ID for the employee or contingent worker. type: String - contextPath: Workday.Worker.User_ID description: Text attribute identifying the User Name. type: String - contextPath: Workday.Worker.Country description: The worker Country. type: String - contextPath: Workday.Worker.Legal_First_Name description: The worker First Name (Given Name). type: String - contextPath: Workday.Worker.Legal_Last_Name description: The worker Last Name (Family Name). type: String - contextPath: Workday.Worker.Preferred_First_Name description: The worker preferred First Name (Preferred Name). type: String - contextPath: Workday.Worker.Preferred_Last_Name description: The worker preferred Last Name (Preferred Name). type: String - contextPath: Workday.Worker.Position_ID description: Text attribute identifying the Position ID. type: String - contextPath: Workday.Worker.Position_Title description: Text attribute identifying the Position Title. type: String - contextPath: Workday.Worker.Business_Title description: Business title for the position. type: String - contextPath: Workday.Worker.Start_Date description: Date the worker first started work in this position. type: String - contextPath: Workday.Worker.End_Employment_Reason_Reference description: Termination/End Additional Job Reason. type: String - contextPath: Workday.Worker.Worker_Type description: The worker type for the position. type: String - contextPath: Workday.Worker.Position_Time_Type description: The position time type. type: String - contextPath: Workday.Worker.Scheduled_Weekly_Hours description: Scheduled weekly hours for the position. type: String - contextPath: Workday.Worker.Default_Weekly_Hours description: Standard weekly hours for the position. type: String - contextPath: Workday.Worker.Full_Time_Equivalent_Percentage description: Full-time equivalent percentage for the position. type: String - contextPath: Workday.Worker.Exclude_from_Headcount description: If Y, the position will be excluded from headcount reporting. type: String - contextPath: Workday.Worker.Pay_Rate_Type description: Pay rate type for the position. type: String - contextPath: Workday.Worker.Job_Profile_Name description: The name of the job profile. type: String - contextPath: Workday.Worker.Work_Shift_Required description: Returns true if a work shift is required on the position where this job profile is used. type: String - contextPath: Workday.Worker.Critical_Job description: Returns true if the job profile is considered a critical job. type: String - contextPath: Workday.Worker.Business_Site_id description: Business Site ID. type: String - contextPath: Workday.Worker.Business_Site_Name description: The name of the location. type: String - contextPath: Workday.Worker.Business_Site_Type description: The type of a location. type: String - contextPath: Workday.Worker.Business_Site_Address.Address_ID description: Business site address ID. type: String - contextPath: Workday.Worker.Business_Site_Address.Formatted_Address description: The formatted address in the format specified for the country. type: String - contextPath: Workday.Worker.Business_Site_Address.Country description: Country of the address. type: String - contextPath: Workday.Worker.Business_Site_Address.Postal_Code description: The postal code part of the address. type: String - contextPath: Workday.Worker.End_Date description: The effective date of the end employment business process. type: String - contextPath: Workday.Worker.Pay_Through_Date description: The pay through date for the end of employment. type: String - contextPath: Workday.Worker.Active description: Boolean attribute identifying whether the Worker is Active. type: String - contextPath: Workday.Worker.Hire_Date description: The most recent hire date for the employee or contract start date for the contingent worker. type: String - contextPath: Workday.Worker.Hire_Reason description: Reason for Hire from the most recent Hire event. type: String - contextPath: Workday.Worker.First_Day_of_Work description: First Day of Work (only applies to the Payroll web service). type: String - contextPath: Workday.Worker.Retired description: Boolean attribute identifying whether the Worker is currently retired. type: String - contextPath: Workday.Worker.Days_Unemployed description: Number of days unemployed since the employee first joined the work force. Used only for China. type: String - contextPath: Workday.Worker.Terminated description: Boolean attribute identifying whether the Worker is currently Terminated. type: String - contextPath: Workday.Worker.Termination_Date description: Most recent Termination Date. type: String - contextPath: Workday.Worker.Primary_Termination_Reason description: The primary reason for the worker's most recent termination. type: String - contextPath: Workday.Worker.Primary_Termination_Category description: Reference to primary termination reason category. type: String - contextPath: Workday.Worker.Termination_Involuntary description: Indicates if the termination was involuntary. type: String - contextPath: Workday.Worker.Rehire description: Returns "Yes" if the worker is a rehire based on the most recent hire event. type: String - contextPath: Workday.Worker.Termination_Last_Day_of_Work description: Last day worked for the worker's termination event. type: String - contextPath: Workday.Worker.Resignation_Date description: Date the employee submitted their resignation. type: String - contextPath: Workday.Worker.Has_International_Assignment description: Indicates whether the worker has internaitonal assignment. type: String - contextPath: Workday.Worker.Home_Country_Reference description: Contains the home country for worker's primary job (ISO_3166-1_Alpha-2_Code). type: String - contextPath: Workday.Worker.Photo description: Worker's photo in base64. type: String - contextPath: Workday.Worker.Addresses.Address_ID description: Worker's address ID. type: String - contextPath: Workday.Worker.Addresses.Formatted_Address description: The formatted address in the format specified for the country. type: String - contextPath: Workday.Worker.Addresses.Country description: Country for the worker's address. type: String - contextPath: Workday.Worker.Addresses.Region description: The ID of the region (ISO_3166-2_Code). type: String - contextPath: Workday.Worker.Addresses.Region_Descriptor description: The region part of the address. Typically this contains the state/province information. type: String - contextPath: Workday.Worker.Addresses.Postal_Code description: The postal code part of the address. type: String - contextPath: Workday.Worker.Addresses.Type description: Address type. type: String - contextPath: Workday.Worker.Emails.Email_Address description: Email address information. type: String - contextPath: Workday.Worker.Emails.Type description: Usage type. type: String - contextPath: Workday.Worker.Emails.Primary description: Indicates if the communication method is primary. type: String - contextPath: Workday.Worker.Emails.Public description: Indicates if the email address is public. type: String - contextPath: Workday.Worker.Phones.ID description: Phone ID. type: String - contextPath: Workday.Worker.Phones.Phone_Number description: Phone number. type: String - contextPath: Workday.Worker.Phones.Type description: Phone Device Type. type: String - contextPath: Workday.Worker.Phones.Usage description: Phone usage data. type: String - contextPath: Workday.Worker.Manager.Manager_ID description: The manager worker ID. type: String - contextPath: Workday.Worker.Manager.Manager_Name description: The manager name. type: String runonce: false script: '-' type: python subtype: python3 dockerimage: demisto/python3:3.12.13.10116658 fromversion: 5.0.0 tests: - Workday - Test