SystemSIPAuthenticationEndpointLockoutGetRequest

Bases: OCIRequest

Request to get sip authentication endpoint lockout data in the system. The response is either a SystemSIPAuthenticationEndpointLockoutGetResponse or an ErrorResponse.

Attributes:

response_size_limit (Optional[int]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

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_user_id (Optional[List[SearchCriteriaUserId]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SystemSIPAuthenticationEndpointLockoutGetRequest(OCIRequest):
    """Request to get sip authentication endpoint lockout data in the system.
         The response is either a SystemSIPAuthenticationEndpointLockoutGetResponse or an ErrorResponse.

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        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_user_id (Optional[List[SearchCriteriaUserId]]):

    """

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

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_exact_organization_type: Optional[
        SearchCriteriaExactOrganizationType
    ] = field(default=None, metadata={"alias": "searchCriteriaExactOrganizationType"})

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

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

Responses

Bases: OCIDataResponse

Response to SystemSIPAuthenticationEndpointLockoutGetRequest. The column headings for the lockoutTable are: "Organization Id", "Organization Type", "Group Id", "Line/Port", "User ID", "First Name", "Last Name", "Lockout Started", "Lockout Expires", "Lockout Count". Lockout times are shown in the system GMT time. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent.

Attributes:

lockout_table (OCITable):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SystemSIPAuthenticationEndpointLockoutGetResponse(OCIDataResponse):
    """Response to SystemSIPAuthenticationEndpointLockoutGetRequest.
        The column headings for the lockoutTable are:
           \"Organization Id\", \"Organization Type\", \"Group Id\", \"Line/Port\", \"User ID\", \"First Name\", \"Last Name\", \"Lockout Started\", \"Lockout Expires\", \"Lockout Count\". Lockout times are shown in the system GMT time. When a permanent lockout is shown, the \"Lockout Expires\" column is empty and the \"Lockout Count\" column contains the word Permanent.

    Attributes:

        lockout_table (OCITable):

    """

    lockout_table: OCITable = field(metadata={"alias": "lockoutTable"})

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 SystemSIPAuthenticationEndpointLockoutGetRequest

client = Client()

command = SystemSIPAuthenticationEndpointLockoutGetRequest(
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemSIPAuthenticationEndpointLockoutGetRequest",
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
)

print(response)