- pynetdicom._handlers.doc_handle_userid(event: Event, *args: Sequence[Any]) Tuple[bool, Optional[bytes]] ¶
Documentation for handlers bound to
User implementation of this handler is required if User Identity Negotiation is to be supported by the association. If no handler is implemented and bound to
evt.EVT_USER_IDthen the association will be accepted (provided there’s no other reason to reject it) and no User Identity Negotiation response will be sent in reply even if one is requested.
event (events.Event) –
The event representing an association request being received which contains a User Identity Negotiation item.
primary_field: the Primary Field value (as
bytes), contains the username, the encoded Kerberos ticket or the JSON web token, depending on the value of user_id_type.
secondary_field: the Secondary Field value. Will be
Noneunless the user_id_type is
2in which case it will be
user_id_type: the User Identity Type value (as an
int), which indicates the form of user identity being provided:
1- Username as a UTF-8 string
2- Username as a UTF-8 string and passcode
3- Kerberos Service ticket
4- SAML Assertion
5- JSON Web Token
args – If the handler was bound to the event using
bind(event, handler, args)or by passing
evt_handlers=[(event, handler, args), ...], where args is a
listthen there will be one or more optional extra parameters matching the contents of args.
is_verified (bool) – Return
Trueif the user identity has been confirmed and you wish to proceed with association establishment,
response (bytes or None) – If user_id_type is:
DICOM Standard, Part 7, Annex D.3.3.7