Logon User External

class q2_sdk.hq.models.external_auth.logon_user_external.Oauth2Config(client_id, client_secret, token_url, authorize_url, redirect_uri, well_known_url=None, jwks_url=None, audience=None)[source]

Bases: object

Oauth2Config(client_id: ‘str’, client_secret: ‘str’, token_url: ‘str’, authorize_url: ‘str’, redirect_uri: ‘str’, well_known_url: ‘Optional[str]’ = None, jwks_url: ‘Optional[str]’ = None, audience: ‘Optional[str]’ = None)

class q2_sdk.hq.models.external_auth.logon_user_external.Request(raw, code, state, is_prelogon_session, session_id)[source]: Bases: BaseAuthRequest

class q2_sdk.hq.models.external_auth.logon_user_external.Response(standard_auth_response_fields)[source]

Bases: BaseAuthResponse

Requires the user_identifier, which Q2_SSOUserLogon.SSOIdentifier field in the database and creates a user session.

This is typically the “sub” field if you are dealing with a jwt access_token.

<Q2Bridge request="LogonUserExternal" messageId="messageID">");
  <Status>Success</Status>
  <UserIdentifier>Q2_SSOUserLogon.SsoIdentifier</UserIdentifier>
</Q2Bridge>

classmethod get_success(user_identifier)[source]: Returns OK to HQ

classmethod get_failure(*args, **kwargs)

Returns Failure to HQ

Return type:: Self