Service Directory > v31.2 > Integrations > Get_Integration_System_Users
 

Operation: Get_Integration_System_Users

This operation will retrieve data related to Workday Accounts associated to an Integration System.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Integration_System_Users_Request

Get Integration System Users Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Integration_System_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Integration System and its associated data.   
Integration_System_Request_Criteria  Integration_System_Request_Criteria  [0..1]  Pass in a request criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Integration_System_Users_Response

Root Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Integration_System_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Integration System and its associated data.   
Request_Criteria  Integration_System_Request_Criteria  [0..1]  Pass in a request criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Integration_System_User_Response_Data  [0..1]  Integration System User Response Data element   
top
 

Integration_System_Request_References

part of: Get_Integration_System_Users_Request, Get_Integration_System_Users_Response
Utilize the Request References element to retrieve a specific instance(s) of Integration System and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System__Audited_Object  [1..*]  Unique identifier for an Integration System reference   
top
 

Integration_System__Audited_Object

part of: Integration_System_User_Data, Integration_System_Request_References, Integration_System_User
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Integration_System__Audited_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_System__Audited_ObjectID

part of: Integration_System__Audited_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Integration_System_Request_Criteria

part of: Get_Integration_System_Users_Request, Get_Integration_System_Users_Response
Pass in a request criteria
 
Parameter name Type/Value Cardinality Description Validations
System_User_Reference  System_UserObject  [0..*]  Pass in a system user reference   
top
 

System_UserObject

part of: Integration_System_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  System_UserObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

System_UserObjectID

part of: System_UserObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Integration_System_Users_Request, Get_Integration_System_Users_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Integration_System_Users_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Integration_System_User_Response_Data

part of: Get_Integration_System_Users_Response
Integration System User Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_User  Integration_System_User  [0..*]  Integration System User element   
top
 

Integration_System_User

part of: Integration_System_User_Response_Data
Integration System User element
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System__Audited_Object  [1..1]  Integration System Reference   
Integration_System_User_Data  Integration_System_User_Data  [0..1]  Integration System User Data element 
Validation Description
System User to be assigned to an Integration System must not be a Worker or Implementer, nor may it already be associated with a different Integration System. Either choose another System User or create a new one.  System User to be assigned to an Integration System must not be a Worker or Implementer, nor may it already be associated with a different Integration System. Either choose another System User or create a new one. 
Password is required when creating a new Workday Account.  Password is required when creating a new Workday Account. 
 
top
 

Integration_System_User_Data

part of: Integration_System_User
Integration System User Data element
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Integration System Reference   
User_Name  string  [0..1]  User Name   
Password [Choice]   string  [0..1]  Text attribute identifying Password. 
Validation Description
The password does not meet password requirements.  Password must meet password requirements. 
 
Generate_Random_Password [Choice]   boolean  [0..1]  The system should generate a random password for the user.   
Require_New_Password_At_Next_Sign_In  boolean  [0..1]  The user will be required to change their password upon initial sign on.   
Session_Timeout_Minutes  decimal (3, 0) >0   [0..1]  The amount of time after which an unused session will expire. Session Timeout Minutes defaults to the value configured in the Password Rules unless set to a non-zero value. 
Validation Description
Session Timeout Minutes must be greater than 5 and less than or equal to [max]. The default value is [default].   
 
Do_Not_Allow_UI_Sessions  boolean  [0..1]  This field allows restricting integration system user accounts from signing in to Workday in the user interface (UI). Integration system accounts should only be used for web service integrations. If the field is true, the integration system user will not be able to sign in to the UI, but will still be able to make web service requests. If the field is false, the integration system user will be able to sign in from both the UI and through web services.   
Web_Service_Security_Configuration_Data  Web_Service_Security_Configuration_Data  [0..*]  A valid instance of Web Service Security Configuration 
Validation Description
Either setting X509 Token Authentication or SAML Token Authentication is required when setting up a new Web Service Security Configuration. If neither of these options is set, this element data is not required.  This validation requires user to set either X509 Token Authentication or SAML Token Authentication when setting up a new Web Service Security Configuration. 
 
Validation Description
System User to be assigned to an Integration System must not be a Worker or Implementer, nor may it already be associated with a different Integration System. Either choose another System User or create a new one.  System User to be assigned to an Integration System must not be a Worker or Implementer, nor may it already be associated with a different Integration System. Either choose another System User or create a new one. 
Password is required when creating a new Workday Account.  Password is required when creating a new Workday Account. 
top
 

Web_Service_Security_Configuration_Data

part of: Integration_System_User_Data
A valid instance of Web Service Security Configuration
 
Parameter name Type/Value Cardinality Description Validations
Enable_x509_Token_Authentication  boolean  [0..1]  Indicates if WS-Security x509 Certificate Token Profile authentication is enabled.   
X509_Public_Key_Reference  x509_Public_KeyObject  [0..1]  x509 Encryption Certificate used to sign requests 
Validation Description
X509 Public Key is required when X509 Token Authentication is enabled.   
 
Enable_SAML_Authentication  boolean  [0..1]  Indicates if WS-Security SAML Token Profile authentication is enabled.   
SAML_Issuer  string  [0..1]  Unique identifier of the SAML identity provider. 
Validation Description
An identifier of the SAML Identity Provider is required when SAML authentication is enabled.   
 
Identity_Provider_Public_Key_Reference  x509_Public_KeyObject  [0..1]  x509 Encryption Certificate of the SAML identity provider. 
Validation Description
An x509 Certificate Reference is needed to Enable SAML Access.   
 
Holder-of-Key_Public_Key_Reference  x509_Public_KeyObject  [0..1]  x509 Encryption Certificate of the holder-of-key. This key is used to verify the signature of the inbound SOAP message.   
Validation Description
Either setting X509 Token Authentication or SAML Token Authentication is required when setting up a new Web Service Security Configuration. If neither of these options is set, this element data is not required.  This validation requires user to set either X509 Token Authentication or SAML Token Authentication when setting up a new Web Service Security Configuration. 
top
 

x509_Public_KeyObject

part of: Web_Service_Security_Configuration_Data, Web_Service_Security_Configuration_Data, Web_Service_Security_Configuration_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  x509_Public_KeyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

x509_Public_KeyObjectID

part of: x509_Public_KeyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Certificate_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

x509_Public_KeyReferenceEnumeration

part of: x509_Public_KeyObjectID
Base Type
string
top