Service Directory > v31.2 > Human_Resources > Get_User-Based_Security_Group_Assignments
 

Operation: Get_User-Based_Security_Group_Assignments

Retrieves Workday Account and it's assigned user-based security groups.


@ - 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_Assign_User-Based_Security_Groups_Request

Get Request wrapper for retrieving Workday Accounts and assigned User-Based Security Groups.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Assign_User-Based_Security_Groups_Request_References  [0..1]  Request References element for retrieving specific Workday Accounts and their assigned User-Based Security Groups.   
Request_Criteria  Assign_User-Based_Security_Groups_Request_Criteria  [0..1]  Element containing the Request Criteria for Assign User-Based Security groups   
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  Assign_User-Based_Security_Groups_Response_Group  [0..1]  Element wrapping the controls what information is returned in the Response Data content   
top
 

Response Element: Get_Assign_User-Based_Security_Groups_Response

Response wrapper for retrieving Workday Accounts and assigned User-Based Security Groups.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Assign_User-Based_Security_Groups_Request_References  [0..1]  Request References element for retrieving specific Workday Accounts and their assigned User-Based Security Groups.   
Request_criteria  Assign_User-Based_Security_Groups_Request_Criteria  [0..1]  Element containing the Request Criteria for Assign User-Based Security groups   
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  Assign_User-Based_Security_Groups_Response_Group  [0..1]  Element wrapping the controls what information is returned in the Response Data content   
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  Assign_User-Based_Security_Groups_Response_Data  [0..1]  Response Data for retrieving Workday Accounts and their assigned User-Based Security Groups.   
top
 

Assign_User-Based_Security_Groups_Request_References

part of: Get_Assign_User-Based_Security_Groups_Request, Get_Assign_User-Based_Security_Groups_Response
Request References element for retrieving specific Workday Accounts and their assigned User-Based Security Groups.
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Reference  System_UserObject  [0..*]  Workday Account Reference   
top
 

System_UserObject

part of: Assign_User-Based_Security_Groups_Data, Assign_User-Based_Security_Groups_Request_References, Assign_User-Based_Security_Groups
 
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
 

Assign_User-Based_Security_Groups_Request_Criteria

part of: Get_Assign_User-Based_Security_Groups_Request, Get_Assign_User-Based_Security_Groups_Response
Element containing the Request Criteria for Assign User-Based Security groups
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_User_Name  string  [0..1]  Workday Account Name used in the Request Criteria for Assign User-Based Security Groups Request   
User-Based_Security_Group_Reference [Choice]   User-Based_Security_GroupObject  [0..*]  Requested User-Based Security Group References   
User-Based_Security_Group_Name [Choice]   string  [0..1]  User-Based Security Group Name in the Request Criteria   
top
 

User-Based_Security_GroupObject

part of: Assign_User-Based_Security_Groups_Data, Assign_User-Based_Security_Groups_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  User-Based_Security_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

User-Based_Security_GroupObjectID

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

Response_Filter

part of: Get_Assign_User-Based_Security_Groups_Request, Get_Assign_User-Based_Security_Groups_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
 

Assign_User-Based_Security_Groups_Response_Group

part of: Get_Assign_User-Based_Security_Groups_Request, Get_Assign_User-Based_Security_Groups_Response
Element wrapping the controls what information is returned in the Response Data content
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
Include_User-Based_Security_Group_Assignment_Data  boolean  [0..1]  Boolean flag to indicate include or not the User-Based Security Groups assigned to the Workday Account   
top
 

Response_Results

part of: Get_Assign_User-Based_Security_Groups_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
 

Assign_User-Based_Security_Groups_Response_Data

part of: Get_Assign_User-Based_Security_Groups_Response
Response Data for retrieving Workday Accounts and their assigned User-Based Security Groups.
 
Parameter name Type/Value Cardinality Description Validations
Assign_User-Based_Security_Groups  Assign_User-Based_Security_Groups  [0..*]  Wrapper element for a Workday Account and the User-Based Security Group assignment data.   
top
 

Assign_User-Based_Security_Groups

part of: Assign_User-Based_Security_Groups_Response_Data
Wrapper element for a Workday Account and the User-Based Security Group assignment data.
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Reference  System_UserObject  [0..1]  Unique identifier for a System User reference   
Assign_User-Based_Security_Groups_Data  Assign_User-Based_Security_Groups_Data  [0..1]  Data element containing a Workday Account and the assigned User-Based Security Groups .   
top
 

Assign_User-Based_Security_Groups_Data

part of: Assign_User-Based_Security_Groups
Data element containing a Workday Account and the assigned User-Based Security Groups .
 
Parameter name Type/Value Cardinality Description Validations
Workday_Account_Reference  System_UserObject  [1..1]  Unique identifier for a System User reference   
User-Based_Security_Group_Reference  User-Based_Security_GroupObject  [0..*]  Unique Identifier for a User-Based Security Group.   
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

User-Based_Security_GroupReferenceEnumeration

part of: User-Based_Security_GroupObjectID
Base Type
string
top