Service Directory > v33.1 > Human_Resources > Get_Workday_Account
 

Operation: Get_Workday_Account

Get Workday Accounts for a user or set of users


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

A Generic Workday Account request for workers and non-workers.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Workday_Account_Request_References  [0..1]  Request References   
Request_Criteria  Get_Workday_Account_Request_Criteria  [0..1]  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_Group  Workday_Account_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Workday_Account_Response

Element containing Workday Account Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Workday_Account_Request_References  [0..*]  Request References   
Request_Criteria  Get_Workday_Account_Request_Criteria  [0..*]  Request Criteria   
Response_Filter  Response_Filter  [0..*]  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_Group  Workday_Account_Response_Group  [0..*]  Response Group   
Response_Results  Response_Results  [0..*]  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  Get_Workday_Account_Response_Data  [0..*]  Element containing Workday Account response data.   
top
 

Get_Workday_Account_Request_References

part of: Get_Workday_Account_Request, Get_Workday_Account_Response
Request References
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Reference  RoleObject  [1..*]  Workday Account Reference   
top
 

RoleObject

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

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, External_Learning_Instructor_ID, Former_Worker_ID, Instructor_ID, Learning_Assessor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, 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
 

Get_Workday_Account_Request_Criteria

part of: Get_Workday_Account_Request, Get_Workday_Account_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Workday_Account_Request, Get_Workday_Account_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Workday_Account_Response_Group

part of: Get_Workday_Account_Request, Get_Workday_Account_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Workday_Account_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Get_Workday_Account_Response_Data

part of: Get_Workday_Account_Response
Element containing Workday Account response data.
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Response_Data  Get_Workday_Account  [0..*]  Element containing Workday Account Data   
top
 

Get_Workday_Account

part of: Get_Workday_Account_Response_Data
Element containing Workday Account information.
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Reference  RoleObject  [0..1]  A unique identifier for the Workday Account.   
Workday_Account_for_Worker_Data  Workday_Account_for_Worker_Data  [0..*]  Encapsulating element containing all Workday Account data. 
Validation Description
User Name already taken, please choose another one.  User Name must be unique within the Workday system. 
Either Password parameter or Generate_Random_Password parameter must be set to false.  Either Password parameter or Generate_Random_Password parameter must be set to false. 
If Generate_Random_Password parameter is set to true, Require_New_Password_at_Next_Login parameter must also be set to true.  If Generate_Random_Password parameter is set to true, Require_New_Password_at_Next_Login parameter must also be set to true. 
The value specified is not configured for this country.  User Language Setting is Configured for System User's Country but User Language is not valid 
Preferred Communication Language is not allowed for this country.   
The value specified is not configured for this country.  User Language Setting is not configured for System User's Country 
 
top
 

Workday_Account_for_Worker_Data

part of: Get_Workday_Account
Encapsulating element containing all Workday Account data.
 
Parameter name Type/Value Cardinality Description Validations
User_Name  string  [1..1]  Text attribute identifying User Name. 
Validation Description
User Name Parameter must not contain any semicolons or colons  User Name Parameter must not contain any semicolons or colons 
The entered User Name is longer than the current tenant maximum. The tenant max is set to [max].   
 
Password  string  [0..1]  Text attribute identifying Password. 
Validation Description
The password does not meet password requirements.  Password must meet password requirements. 
 
Generate_Random_Password  boolean  [0..1]  If True, generates a random password for the specified Workday Account and emails the new password to the email address associated with that account. If False, a new password can be provided in a different field, or if that is not provided, the associated Workday Account's password is unchanged. 
Validation Description
If Generate_Random_Password is true, the user must have an email address on file, the tenant must be set up to send security emails, and the user cannot use delegated authentication.  If Generate_Random_Password is true, the user must have an email address on file, the tenant must be set up to send security emails, and the user cannot use delegated authentication. 
 
Require_New_Password_at_Next_Sign_In  boolean  [0..1]  Boolean attribute identifying whether user will need to enter a new password upon next sign-in to the Workday system.   
Multi-factor_Authentication_Exempt  boolean  [0..1]  True when the user is exempt from One-Time Passcode Authentication, False otherwise. Set this element to true if you want the user to be exempt from one-time passcode authentication. 
Validation Description
One-Time Passcode Exempt cannot be modified if the user is not required to use One-Time Passcode Authentication.  One-Time Passcode Exempt cannot be modified if the user is not required to use One-Time Passcode Authentication. 
 
Multi-factor_Authentication_Grace_Period_Disabled  boolean  [0..1]  True when the user's grace period is disabled, False otherwise. Set this element to false if you want the user's grace period to be enabled.   
Grace_Period_Logins_Remaining  decimal (12, 0)   [0..1]  The remaining number of times the user can login without providing multi-factor authentication. This cannot be higher than the configured tenant maximum grace period login count. 
Validation Description
Grace Period Remaining Login Count cannot be less than 0 or greater than the tenant Maximum Grace Period Login Count: [max count].  Grace Period Remaining Login Count cannot be less than 0 or greater than the tenant Maximum Grace Period Login Count 
 
Multi-factor_Authentication  Multi-factor_Authentication_for_Worker_Data  [0..*]  Individual multi-factor authentication.   
Account_Disabled  boolean  [0..1]  Boolean attribute identifying whether Workday Account is disabled.   
Account_Expiration_Date  dateTime  [0..1]  The user will be prevented from signing on to the system after this date (Pacific Time).   
OpenID_Identifier  string  [0..1]  This field is used for OpenID based authentication and contains the email address associated with the OpenID account. This value needs to be provided to enable OpenID authentication for this user.   
OpenID_Internal_Identifier  string  [0..1]  This field is used for OpenID based authentication and contains the OpenID GUID. It will be unpopulated until the user completes an initial successful OpenID authentication attempt.   
OpenID_Connect_Internal_Identifier  string  [0..1]  This field is used for OpenID Connect based authentication and contains the OpenID Connect subject. It will be unpopulated until the user completes an initial successful OpenID Connect authentication attempt.   
Delegated_Authentication_Integration_System_Reference  Integration_System__Audited_Object  [0..1]  The user will be authenticated via an external system.   
Session_Timeout_Minutes  decimal (3, 0) >0   [0..1]  The number of minutes the user may be idle before the system requires them to re-enter their user name and password. 
Validation Description
Session Timeout Minutes must be greater than 5 and less than or equal to [max]. The default value is [default].   
 
Show_User_Name_in_Browser_Window  boolean  [0..1]  The web browser title will include the user name in parenthesis.   
Display_XML_Icon_on_Reports  boolean  [0..1]  The user will be presented with an icon to view reports as an RSS feed.   
Enable_Workbox  boolean  [0..1]  The user will have the Workbox tab available in the right-side slide-out.   
Locale_Reference  LocaleObject  [0..1]  The local defines the user's language and country which will affect their experience in the Workday system.   
User_Language_Reference  User_LanguageObject  [0..1]  If set, specifies language for user. If not set, language specification taken from Locale_Reference   
Preferred_Communication_Language_Reference  User_LanguageObject  [0..1]  Captures the Preferred Communication Language   
Preferred_Search_Scope_Reference  Unique_IdentifierObject  [0..1]  If set, specifies the initial search category displayed to the user.   
Allow_Mixed-Language_Transactions  boolean  [0..1]  The user is allowed to view mixed language transactions.   
Notification_Sub_Type_Configurations  Notification_Sub_Category_Configurations_for_Users  [0..*]  Notification Type configurations for a particular user   
Exempt_from_Delegated_Authentication  boolean  [0..1]  True when the user is exempt from Delegated Authentication, False otherwise. Set this element to true if you want the user to be exempt from delegated authentication.   
Validation Description
User Name already taken, please choose another one.  User Name must be unique within the Workday system. 
Either Password parameter or Generate_Random_Password parameter must be set to false.  Either Password parameter or Generate_Random_Password parameter must be set to false. 
If Generate_Random_Password parameter is set to true, Require_New_Password_at_Next_Login parameter must also be set to true.  If Generate_Random_Password parameter is set to true, Require_New_Password_at_Next_Login parameter must also be set to true. 
The value specified is not configured for this country.  User Language Setting is Configured for System User's Country but User Language is not valid 
Preferred Communication Language is not allowed for this country.   
The value specified is not configured for this country.  User Language Setting is not configured for System User's Country 
top
 

Multi-factor_Authentication_for_Worker_Data

part of: Workday_Account_for_Worker_Data
Multi-factor Authentication Information.
 
Parameter name Type/Value Cardinality Description Validations
Multi-factor_Authentication_Type_Reference  Unique_IdentifierObject  [0..1]  Multi-factor Authentication Type Reference.   
Reset  boolean  [0..1]  Set this element to true if you want to reset the user's multi-factor authentication status.   
top
 

Unique_IdentifierObject

part of: Workday_Account_for_Worker_Data, User_Notification_Frequency_Configuration_Data, User_Notification_Frequency_Configuration_Data, Multi-factor_Authentication_for_Worker_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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [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_Object

part of: Workday_Account_for_Worker_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  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
 

LocaleObject

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

LocaleObjectID

part of: LocaleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Locale_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
 

User_LanguageObject

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

User_LanguageObjectID

part of: User_LanguageObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, User_Language_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
 

Notification_Sub_Category_Configurations_for_Users

part of: Workday_Account_for_Worker_Data
Notification Type configurations for a particular user
 
Parameter name Type/Value Cardinality Description Validations
Notification_Sub_Type_Configuration  Notification_Sub_Type_Configuration  [0..*]  Notification Sub Type configuration(includes selected notification channels) for each Notification Sub Type.   
top
 

Notification_Sub_Type_Configuration

part of: Notification_Sub_Category_Configurations_for_Users
Notification sub type configuration for each notification sub type
 
Parameter name Type/Value Cardinality Description Validations
Notification_Sub_Type_Reference  Notification_CategorizableObject  [0..1]  Notification sub type for which notification channels will be updated/added. 
Validation Description
Notification Type [Notification Sub Category] must be enabled for user preferences in order to update Notification Channels   
 
User_Notification_Frequency_Configuration  User_Notification_Frequency_Configuration_Data  [0..*]  Notification Frequency Configurations for Notification Categorizable 
Validation Description
You can't set Channel Delivery Frequency if User Preference is disabled for the channel.   
 
top
 

Notification_CategorizableObject

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

Notification_CategorizableObjectID

part of: Notification_CategorizableObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, NOTIFICATION_CATEGORY  [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
 

User_Notification_Frequency_Configuration_Data

part of: Notification_Sub_Type_Configuration
Set the Notification Frequency for the channel.
 
Parameter name Type/Value Cardinality Description Validations
Channel_Reference  Unique_IdentifierObject  [1..1]  Channel for Notification Frequency Configuration 
Validation Description
[Channel] has not been enabled for user preferences for sub type [Notification Type].   
 
Delivery_Frequency_Reference  Unique_IdentifierObject  [1..1]  Delivery frequency for Notification Type 
Validation Description
The Frequency [frequency] is no longer valid for the Channel [channel] and Notification Type [type].   
 
Validation Description
You can't set Channel Delivery Frequency if User Preference is disabled for the channel.   
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

LocaleReferenceEnumeration

part of: LocaleObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top
 

Notification_CategorizableReferenceEnumeration

part of: Notification_CategorizableObjectID
Base Type
string
top