Skip to content

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/commands/commands.py
@dataclass(kw_only=True)
class UserGetListInGroupPagedSortedListRequest(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]):

    """

    service_provider_id: Optional[str] = field(
        default=None, metadata={"alias": "serviceProviderId"}
    )

    group_id: Optional[str] = field(default=None, metadata={"alias": "groupId"})

    group_external_id: Optional[str] = field(
        default=None, metadata={"alias": "groupExternalId"}
    )

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[List[SortOrderUserGetListInGroupPagedSortedList]] = field(
        default=None, metadata={"alias": "sortOrder"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_exact_user_in_trunk_group: Optional[
        SearchCriteriaExactUserInTrunkGroup
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserInTrunkGroup"})

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_user_external_id: Optional[List[SearchCriteriaUserExternalId]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserExternalId"})
    )

    search_criteria_exact_user_person_id: Optional[SearchCriteriaExactUserPersonId] = (
        field(default=None, metadata={"alias": "searchCriteriaExactUserPersonId"})
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_exact_dn_activation: Optional[SearchCriteriaExactDnActivation] = (
        field(default=None, metadata={"alias": "searchCriteriaExactDnActivation"})
    )

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

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/commands/commands.py
@dataclass(kw_only=True)
class UserGetListInGroupPagedSortedListResponse(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):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.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.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)