sym.sdk.exceptions.identity¶

Exceptions

`CouldNotSaveError`	This error is raised in cases where a `UserIdentity` was unable to be saved.
`IdentityError`	This is the base class for errors that occur when managing identities.
`IdentityNotFound`	This error is raised in cases where a mapping of a Sym `User` to an external identity (i.e., a `UserIdentity`) could not be found and could not be automatically determined from the corresponding service.

exception sym.sdk.exceptions.identity.CouldNotSaveError(message: str)¶

Bases: sym.sdk.exceptions.identity.IdentityError

This error is raised in cases where a UserIdentity was unable to be saved.

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception sym.sdk.exceptions.identity.IdentityError(name: str, message: str, error_type: str = 'Identity')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for errors that occur when managing identities.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. COULD_NOT_SAVE)
message – The exception message to display

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception sym.sdk.exceptions.identity.IdentityNotFound(email: str, service_id: str)¶

Bases: sym.sdk.exceptions.identity.IdentityError, sym.sdk.exceptions.sym_exception.ExceptionWithHint

This error is raised in cases where a mapping of a Sym User to an external identity (i.e., a UserIdentity) could not be found and could not be automatically determined from the corresponding service.

Parameters

email – The email address of the user for which identity lookup could not be performed
service_id – The unique Implementer-provided identifier of the service for which identity lookup was needed

property hint¶: The string to be displayed in the Hint section

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.