Skip to content

GroupAccessDeviceGetUserListRequest21sp1

Bases: OCIRequest

Requests the configuration of a specified group access device. The response is either GroupAccessDeviceGetUserListResponse21sp1 or ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

response_size_limit (Optional[int]):

search_criteria_line_port_user_part (Optional[List[SearchCriteriaLinePortUserPart]]):

search_criteria_line_port_domain (Optional[List[SearchCriteriaLinePortDomain]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_exact_endpoint_type (Optional[SearchCriteriaExactEndpointType21sp1]):

search_criteria_exact_user_type (Optional[SearchCriteriaExactUserType]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_port_number (Optional[SearchCriteriaExactPortNumber]):

search_criteria_access_device_endpoint_private_identity (Optional[List[SearchCriteriaAccessDeviceEndpointPrivateIdentity]]):

search_criteria_user_hotline_contact (Optional[List[SearchCriteriaUserHotlineContact]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupAccessDeviceGetUserListRequest21sp1(OCIRequest):
    """Requests the configuration of a specified group access device.
        The response is either GroupAccessDeviceGetUserListResponse21sp1 or ErrorResponse.
        The following elements are only used in XS data mode and ignored in AS data mode:
          searchCriteriaAccessDeviceEndpointPrivateIdentity

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

        response_size_limit (Optional[int]):

        search_criteria_line_port_user_part (Optional[List[SearchCriteriaLinePortUserPart]]):

        search_criteria_line_port_domain (Optional[List[SearchCriteriaLinePortDomain]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_exact_endpoint_type (Optional[SearchCriteriaExactEndpointType21sp1]):

        search_criteria_exact_user_type (Optional[SearchCriteriaExactUserType]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_port_number (Optional[SearchCriteriaExactPortNumber]):

        search_criteria_access_device_endpoint_private_identity (Optional[List[SearchCriteriaAccessDeviceEndpointPrivateIdentity]]):

        search_criteria_user_hotline_contact (Optional[List[SearchCriteriaUserHotlineContact]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    device_name: str = field(metadata={"alias": "deviceName"})

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

    search_criteria_line_port_user_part: Optional[
        List[SearchCriteriaLinePortUserPart]
    ] = field(default=None, metadata={"alias": "searchCriteriaLinePortUserPart"})

    search_criteria_line_port_domain: Optional[List[SearchCriteriaLinePortDomain]] = (
        field(default=None, metadata={"alias": "searchCriteriaLinePortDomain"})
    )

    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_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_exact_endpoint_type: Optional[
        SearchCriteriaExactEndpointType21sp1
    ] = field(default=None, metadata={"alias": "searchCriteriaExactEndpointType"})

    search_criteria_exact_user_type: Optional[SearchCriteriaExactUserType] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserType"}
    )

    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"})

    search_criteria_exact_port_number: Optional[SearchCriteriaExactPortNumber] = field(
        default=None, metadata={"alias": "searchCriteriaExactPortNumber"}
    )

    search_criteria_access_device_endpoint_private_identity: Optional[
        List[SearchCriteriaAccessDeviceEndpointPrivateIdentity]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaAccessDeviceEndpointPrivateIdentity"},
    )

    search_criteria_user_hotline_contact: Optional[
        List[SearchCriteriaUserHotlineContact]
    ] = field(default=None, metadata={"alias": "searchCriteriaUserHotlineContact"})

Responses

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 GroupAccessDeviceGetUserListRequest21sp1

client = Client()

command = GroupAccessDeviceGetUserListRequest21sp1(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    response_size_limit=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_user_id=...,
    search_criteria_exact_endpoint_type=...,
    search_criteria_exact_user_type=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_port_number=...,
    search_criteria_access_device_endpoint_private_identity=...,
    search_criteria_user_hotline_contact=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceGetUserListRequest21sp1",
    service_provider_id=...,
    group_id=...,
    device_name=...,
    response_size_limit=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_user_id=...,
    search_criteria_exact_endpoint_type=...,
    search_criteria_exact_user_type=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_port_number=...,
    search_criteria_access_device_endpoint_private_identity=...,
    search_criteria_user_hotline_contact=...,
)

print(response)