Skip to content

AuthenticationVerifyRequest22V4

Bases: OCIRequest

AuthenticationVerifyRequest22V4 is used to authenticate a user either by userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest. The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user's password associated with userId.

The response is a AuthenticationVerifyResponse22V4 or an ErrorResponse

Attributes:

user_id (Optional[str]):

password (Optional[str]):

phone_number (Optional[str]):

passcode (Optional[str]):

line_port (Optional[str]):

password (Optional[str]):

login_token (Optional[str]):

sip_authentication_user_name (Optional[str]):

sip_authentication_password (Optional[str]):

user_id (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class AuthenticationVerifyRequest22V4(OCIRequest):
    """AuthenticationVerifyRequest22V4 is used to authenticate a user either by userId/password, userId/sip username/sip password,
        dn/passcode, lineport/password or a token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest.
        The phone number may be any DN associated with a user.
        The lineport may be any lineport associated with a user.
        The password used for the lineport is the user's password associated with userId.

        The response is a AuthenticationVerifyResponse22V4 or an ErrorResponse

    Attributes:

        user_id (Optional[str]):

        password (Optional[str]):

        phone_number (Optional[str]):

        passcode (Optional[str]):

        line_port (Optional[str]):

        password (Optional[str]):

        login_token (Optional[str]):

        sip_authentication_user_name (Optional[str]):

        sip_authentication_password (Optional[str]):

        user_id (Optional[str]):

    """

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

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

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

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

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

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

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

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

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

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

Responses

Bases: OCIDataResponse

Response to AuthenticationVerifyRequest22V4

The following data elements are only returned in AS data mode:
  resellerId

If a phoneNumber is returned, it will be the primary DN of the user.

The parameter tokenRevocationTime is represented in the number of milliseconds
since January 1, 1970, 00:00:00 GMT, and it is set to the more current time between
the system level token revocation time and user level token revocation time.

Attributes:

login_type (str):

locale (str):

encoding (str):

group_id (Optional[str]):

service_provider_id (Optional[str]):

is_enterprise (bool):

password_expires_days (Optional[int]):

last_name (Optional[str]):

first_name (Optional[str]):

user_id (str):

phone_number (Optional[str]):

reseller_id (Optional[str]):

token_revocation_time (Optional[int]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class AuthenticationVerifyResponse22V4(OCIDataResponse):
    """Response to AuthenticationVerifyRequest22V4

        The following data elements are only returned in AS data mode:
          resellerId

        If a phoneNumber is returned, it will be the primary DN of the user.

        The parameter tokenRevocationTime is represented in the number of milliseconds
        since January 1, 1970, 00:00:00 GMT, and it is set to the more current time between
        the system level token revocation time and user level token revocation time.

    Attributes:

        login_type (str):

        locale (str):

        encoding (str):

        group_id (Optional[str]):

        service_provider_id (Optional[str]):

        is_enterprise (bool):

        password_expires_days (Optional[int]):

        last_name (Optional[str]):

        first_name (Optional[str]):

        user_id (str):

        phone_number (Optional[str]):

        reseller_id (Optional[str]):

        token_revocation_time (Optional[int]):

    """

    login_type: str = field(metadata={"alias": "loginType"})

    locale: str = field(metadata={"alias": "locale"})

    encoding: str = field(metadata={"alias": "encoding"})

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

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

    is_enterprise: bool = field(metadata={"alias": "isEnterprise"})

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

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

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

    user_id: str = field(metadata={"alias": "userId"})

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

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

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

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 AuthenticationVerifyRequest22V4

client = Client()

command = AuthenticationVerifyRequest22V4(
    user_id=...,
    password=...,
    phone_number=...,
    passcode=...,
    line_port=...,
    password=...,
    login_token=...,
    sip_authentication_user_name=...,
    sip_authentication_password=...,
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("AuthenticationVerifyRequest22V4",
    user_id=...,
    password=...,
    phone_number=...,
    passcode=...,
    line_port=...,
    password=...,
    login_token=...,
    sip_authentication_user_name=...,
    sip_authentication_password=...,
    user_id=...,
)

print(response)