Service Directory > v31.2 > Identity_Management > Get_Workday_Account_Signons
 

Operation: Get_Workday_Account_Signons

This operation gets all Signon or Signon attempts for the specified criteria when the provided User Name was associated with a valid Workday Account. Signon attempts where an unidentified (invalid) User Name was provided are not included. The response includes specific information about the Signon including the Signon DateTime, the Signon IP Address and the associated Workday Account. The time range specified in the request criteria must be less than 24 hours. The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.


@ - 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_Workday_Account_Signons_Request

The request element for the Get Workday Account Signons operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Workday_Account_Signon_Request_Criteria  [0..1]  The request Critera controlling which Workday Account Signons are included in the response. The criteria include User Name and time range. 
Validation Description
The range for Signon request criteria must be 0-24 hours.   
 
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_Workday_Account_Signons_Response

The response element for Get Workday Signons operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Workday_Account_Signon_Request_Criteria  [0..1]  The request Critera controlling which Workday Account Signons are included in the response. The criteria include User Name and time range. 
Validation Description
The range for Signon request criteria must be 0-24 hours.   
 
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  Workday_Account_Signon_Response_Data  [0..1]  Contains the response data for Workday Account Signons.   
top
 

Workday_Account_Signon_Request_Criteria

part of: Get_Workday_Account_Signons_Request, Get_Workday_Account_Signons_Response
The request Critera controlling which Workday Account Signons are included in the response. The criteria include User Name and time range.
 
Parameter name Type/Value Cardinality Description Validations
From_DateTime  dateTime  [0..1]  Request Signon information from this time. The time range between the From_DateTime and To_DateTime must be less than 24 hours.   
To_DateTime  dateTime  [0..1]  Request Signon information to this time. The time range between the From_DateTime and To_DateTime must be less than 24 hours.   
User_Name [Choice]   string  [0..1]  An optional User Name regular expression used to match Workday Accounts. Only Signons for the matched accounts are included in the response.   
Workday_Account_Reference [Choice]   System_AccountObject  [0..*]  Request Signon information for specified Workday Accounts.   
Validation Description
The range for Signon request criteria must be 0-24 hours.   
top
 

System_AccountObject

part of: Workday_Account_Signon_Request_Criteria, Workday_Account_Signon_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  System_AccountObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

System_AccountObjectID

part of: System_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, LearningUserName, RecruitingUserName, StudentUserName, SupplierUserName, System_Account_ID, 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_Workday_Account_Signons_Request, Get_Workday_Account_Signons_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_Workday_Account_Signons_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
 

Workday_Account_Signon_Response_Data

part of: Get_Workday_Account_Signons_Response
Contains the response data for Workday Account Signons.
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Signon  Workday_Account_Signon_Data  [0..*]  Contains data for a Workday Account Signon, including User Name, Workday Account Reference and Signon Time.   
top
 

Workday_Account_Signon_Data

part of: Workday_Account_Signon_Response_Data
Contains data for a Workday Account Signon, including User Name, Workday Account Reference and Signon Time.
 
Parameter name Type/Value Cardinality Description Validations
Signon_DateTime  dateTime  [0..1]  The time that the Signon occurred.   
User_Name  string  [0..1]  The User Name used to signon.   
Successful  boolean  [0..1]  True if the Signon was successful.   
Failed_Signon  boolean  [0..1]  An invalid password was supplied for the Signon attempt.   
Invalid_Credentials  boolean  [0..1]  Indicates whether or not a sign on failed due to the user providing invalid credentials. This could be an invalid password, invalid one-time passcode, invalid SAML, etc. This would not apply to other failure reasons, such as locked and disabled accounts.   
Password_Changed  boolean  [0..1]  The password was changed after the Signon.   
Forgotten_Password_Reset_Request  boolean  [0..1]  A request was made to reset the password in the Signon attempt.   
Authentication_Failure_Message  string  [0..1]  The detail authentication failure message when available.   
Signon_IP_Address  string  [0..1]  The IP address where the Signon originated.   
Signoff_DateTime  dateTime  [0..1]  The signoff time associated with the Signon.   
Authentication_Channel  string  [0..1]  The Authentication Channel of the Signon (UI, Web Services, etc).   
Authentication_Type  string  [0..1]  The Authentication Type of the Signon (Normal, SAML, X509, etc.).   
Workday_Account_Reference  System_AccountObject  [0..1]  The Workday Account for the Signon.   
top
 

System_AccountReferenceEnumeration

part of: System_AccountObjectID
Base Type
string
top