UserGetListInGroupPagedSortedListRequest
Bases: OCIRequest
Request the list of users in a group. The response is either a UserGetListInGroupPagedSortedListResponse or an ErrorResponse.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
It is possible to search by various criteria to restrict the number of rows returned.
If no sortOrder is included the response is sorted by User Id ascending by default.
A limitation to the search by DN activation exists when the Number Activation mode is set to
Off. In this case DNs not assigned to users are never returned by queries with the
"dnActivationSearchCriteria" included.
Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.
The following elements are used in AS data mode and ignored in XS data mode:
groupExternalId
Attributes:
service_provider_id (Optional[str]):
group_id (Optional[str]):
group_external_id (Optional[str]):
response_paging_control (Optional[ResponsePagingControl]):
sort_order (Optional[List[SortOrderUserGetListInGroupPagedSortedList]]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):
search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_user_external_id (Optional[List[SearchCriteriaUserExternalId]]):
search_criteria_exact_user_person_id (Optional[SearchCriteriaExactUserPersonId]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):
search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
108244 108245 108246 108247 108248 108249 108250 108251 108252 108253 108254 108255 108256 108257 108258 108259 108260 108261 108262 108263 108264 108265 108266 108267 108268 108269 108270 108271 108272 108273 108274 108275 108276 108277 108278 108279 108280 108281 108282 108283 108284 108285 108286 108287 108288 108289 108290 108291 108292 108293 108294 108295 108296 108297 108298 108299 108300 108301 108302 108303 108304 108305 108306 108307 108308 108309 108310 108311 108312 108313 108314 108315 108316 108317 108318 108319 108320 108321 108322 108323 108324 108325 108326 108327 108328 108329 108330 108331 108332 108333 108334 108335 108336 108337 108338 108339 108340 108341 108342 108343 108344 108345 108346 108347 108348 108349 108350 108351 108352 108353 108354 108355 108356 108357 108358 108359 108360 108361 108362 108363 108364 108365 108366 108367 108368 | |
Responses
Bases: OCIDataResponse
Response to UserGetListInGroupPagedSortedListRequest. Contains a table with column headings : "User Id", "Last Name", "First Name", "Department", "Department Type", "Parent Department","Parent Department Type", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension", "Country Code", "National Prefix", "User External Id" in a row for each user.
The "Department Type" and "Parent Department Type" columns
will contain the values "Enterprise" or "Group".
The following columns are only populated in AS data mode:
"Country Code", "National Prefix", "User External Id"
Attributes:
user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserGetListInGroupPagedSortedListRequest
client = Client()
command = UserGetListInGroupPagedSortedListRequest(
service_provider_id=...,
group_id=...,
group_external_id=...,
response_paging_control=...,
sort_order=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_department_name=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
search_criteria_exact_dn_activation=...,
search_criteria_mode_or=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserGetListInGroupPagedSortedListRequest",
service_provider_id=...,
group_id=...,
group_external_id=...,
response_paging_control=...,
sort_order=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_department_name=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
search_criteria_exact_dn_activation=...,
search_criteria_mode_or=...,
)
print(response)