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
25869 25870 25871 25872 25873 25874 25875 25876 25877 25878 25879 25880 25881 25882 25883 25884 25885 25886 25887 25888 25889 25890 25891 25892 25893 25894 25895 25896 25897 25898 25899 25900 25901 25902 25903 25904 25905 25906 25907 25908 25909 25910 25911 25912 25913 25914 25915 25916 25917 25918 25919 25920 25921 25922 25923 25924 25925 | |
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
117262 117263 117264 117265 117266 117267 117268 117269 117270 117271 117272 117273 117274 117275 117276 117277 117278 117279 117280 117281 117282 117283 117284 117285 117286 117287 117288 117289 117290 117291 117292 117293 117294 117295 117296 117297 117298 117299 117300 117301 117302 117303 117304 117305 117306 117307 117308 117309 117310 117311 117312 117313 117314 117315 117316 117317 117318 117319 117320 117321 117322 117323 117324 117325 117326 117327 117328 117329 117330 117331 117332 117333 117334 117335 | |
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)