Skip to content

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
@dataclass(kw_only=True)
class UserGetListInServiceProviderRequest(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]):

    """

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

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    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_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_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

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
@dataclass(kw_only=True)
class UserGetListInServiceProviderResponse(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):

    """

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

Bases: OCIResponse

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

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)