User Authorization
API reference for diameter.message.commands.user_authorization.
This module contains User-Authorization Request and Answer messages, implementing AVPs documented in 3GPP TS 29.229.
UserAuthorization ¶
UserAuthorization(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: DefinedMessage
A User-Authorization base message.
This message class lists message attributes based on the current 3GPP TS 29.229 version 13.1.0 Release 13 as python properties, accessible as instance attributes. AVPs not listed in the spec protocol can be retrieved using the UserAuthorization.find_avps search method.
Examples:
AVPs accessible either as instance attributes or by searching:
>>> msg = Message.from_bytes(b"...")
>>> msg.session_id
dra1.mvno.net;2323;546
>>> msg.find_avps((AVP_SESSION_ID, 0))
['dra1.mvno.net;2323;546']
When diameter message is decoded using
Message.from_bytes, it returns
either an instance of UserAuthorizationRequest or
UserAuthorizationAnswer automatically:
>>> msg = Message.from_bytes(b"...")
>>> assert msg.header.is_request is True
>>> assert isinstance(msg, UserAuthorizationRequest)
When creating a new message, the UserAuthorizationRequest or
UserAuthorizationAnswer class should be instantiated directly, and
values for AVPs set as class attributes:
>>> msg = UserAuthorizationRequest()
>>> msg.session_id = "dra1.mvno.net;2323;546"
Other, custom AVPs can be appended to the message using the
UserAuthorization.append_avp method,
or by overwriting the avp attribute entirely. Regardless of the custom
AVPs set, the mandatory values listed in TS 29.229 must be set, however
they can be set as None, if they are not to be used.
Warning
Every AVP documented for the subclasses of this command can be accessed
as an instance attribute, even if the original network-received message
did not contain that specific AVP. Such AVPs will be returned with the
value None when accessed.
Every other AVP not mentioned here, and not present in a
network-received message will raise an AttributeError when being
accessed; their presence should be validated with hasattr before
accessing.
UserAuthorizationAnswer ¶
UserAuthorizationAnswer(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: UserAuthorization
A User-Authorization-Answer message.
vendor_specific_application_id
instance-attribute
¶
vendor_specific_application_id: VendorSpecificApplicationId
UserAuthorizationRequest ¶
UserAuthorizationRequest(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: UserAuthorization
A User-Authorization-Request message.
vendor_specific_application_id
instance-attribute
¶
vendor_specific_application_id: VendorSpecificApplicationId