UserGetListInServiceProviderRequest
Bases: OCIRequest
Request the list of users in a service provider or enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together.
The following elements are only used in AS data mode and ignored in XS data mode:
serviceProviderExternalId
The response is either a UserGetListInServiceProviderResponse or an ErrorResponse.
Attributes:
service_provider_id (Optional[str]):
service_provider_external_id (Optional[str]):
response_size_limit (Optional[int]):
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_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_user_department (Optional[SearchCriteriaExactUserDepartment]):
Source code in src/mercury_ocip_fast/commands/commands.py
108457 108458 108459 108460 108461 108462 108463 108464 108465 108466 108467 108468 108469 108470 108471 108472 108473 108474 108475 108476 108477 108478 108479 108480 108481 108482 108483 108484 108485 108486 108487 108488 108489 108490 108491 108492 108493 108494 108495 108496 108497 108498 108499 108500 108501 108502 108503 108504 108505 108506 108507 108508 108509 108510 108511 108512 108513 108514 108515 108516 108517 108518 108519 108520 108521 108522 108523 108524 108525 108526 108527 108528 108529 108530 108531 108532 108533 108534 108535 108536 108537 108538 108539 108540 108541 108542 108543 108544 108545 108546 108547 108548 | |
Responses
Bases: OCIDataResponse
Response to UserGetListInServiceProviderRequest. Contains a table with column headings : "User Id", "Group Id", "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension", "User External Id" in a row for each user. The following columns are populated in AS data mode only: "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 UserGetListInServiceProviderRequest
client = Client()
command = UserGetListInServiceProviderRequest(
service_provider_id=...,
service_provider_external_id=...,
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
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_user_department=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserGetListInServiceProviderRequest",
service_provider_id=...,
service_provider_external_id=...,
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
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_user_department=...,
)
print(response)