Base

enum q2_sdk.hq.models.external_auth.base.AuthorizationStatus(value)[source]

Bases: Enum

Valid values are as follows:

PasswordIsBad = <AuthorizationStatus.PasswordIsBad: 0>

PasswordIsGood = <AuthorizationStatus.PasswordIsGood: 1>

Expired = <AuthorizationStatus.Expired: 2>

InitialPwdExpired = <AuthorizationStatus.InitialPwdExpired: 4>

LockLogin = <AuthorizationStatus.LockLogin: 8>

DisableLogin = <AuthorizationStatus.DisableLogin: 16>

NextInvalidChangesStatus = <AuthorizationStatus.NextInvalidChangesStatus: 32>

TacRequired = <AuthorizationStatus.TacRequired: 64>

UserTokenCreated = <AuthorizationStatus.UserTokenCreated: 128>

BrowserRegistrationCountExceeded = <AuthorizationStatus.BrowserRegistrationCountExceeded: 256>

RoamingIsAllowed = <AuthorizationStatus.RoamingIsAllowed: 512>

BrowserRegistrationIsAllowed = <AuthorizationStatus.BrowserRegistrationIsAllowed: 1024>

IsMultiChannelAuthenticated = <AuthorizationStatus.IsMultiChannelAuthenticated: 2048>

ExceptionDuringProcessing = <AuthorizationStatus.ExceptionDuringProcessing: 4096>

LockUser = <AuthorizationStatus.LockUser: 8192>

class q2_sdk.hq.models.external_auth.base.StandardAuthResponseFields(success, status_description, hq_error_return_code, end_user_message)[source]

Bases: object

StandardAuthResponseFields(success: ‘bool’, status_description: ‘Optional[str]’, hq_error_return_code: ‘Optional[int]’, end_user_message: ‘Optional[str]’)

class q2_sdk.hq.models.external_auth.base.BaseAuthResponse(standard_auth_response_fields)[source]

Bases: object

All other auth responses have at least this info

<Q2Bridge request="RequestType" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <HQErrorReturnCode>{0}</HQErrorReturnCode>
  <StatusDescription>{0}</StatusDescription>
  <EndUserMessage>{0}</EndUserMessage>
</Q2Bridge>

classmethod get_success(*args, **kwargs)[source]

Returns OK to HQ

Return type:: Self

classmethod get_failure(*args, **kwargs)[source]

Returns Failure to HQ

Return type:: Self

class q2_sdk.hq.models.external_auth.base.BaseAuthRequest(raw)[source]

Bases: object

BaseAuthRequest(raw: ‘objectify.Element’)

class q2_sdk.hq.models.external_auth.base.Password(value, encrypted)[source]

Bases: object

Password(value: ‘str’, encrypted: ‘bool’)