# API Reference This reference covers the main extension points provided by `social-auth-core`. The generated pages include links to the corresponding source code. ## Authentication backends ### *class* social_core.backends.base.BaseAuth(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) A authentication backend that authenticates the user based on the provider response. Set `ASSOCIATION_ONLY` to connect provider access to an authenticated local user without updating their profile. Browser flows must start through `do_auth(user=...)` and validate callbacks with `validate_association_state()` before processing provider credentials. Authentication and disconnect partials remain bound to that local user. #### ASSOCIATION_ONLY *= False* #### EXTRA_DATA *: [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str) | [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str), [bool](https://docs.python.org/3/builtins/functions.html#bool)]] | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### GET_ALL_EXTRA_DATA *= False* #### ID_KEY *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* *= ''* #### LEGACY_ID_KEYS *: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), ...]* *= ()* #### MUTABLE_ID_KEYS *: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), ...]* *= ()* #### REQUIRES_EMAIL_VALIDATION *= False* #### REQUIRES_USER_ID *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* *= False* #### SEND_USER_AGENT *= True* #### association_user_id_key(pipeline_type: [str](https://docs.python.org/3/builtins/stdtypes.html#str) = 'authentication') → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Name of the initiator binding saved in pipeline arguments. #### auth_allowed(response, details) Return True if the user should be allowed to authenticate, by default check if email is whitelisted (if there’s a whitelist) #### auth_complete(\*args, \*\*kwargs) → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) Completes login process, must return user instance #### auth_extra_arguments() → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return extra arguments needed on auth process. Configured AUTH_EXTRA_ARGUMENTS are not overridden by request data by default. Set AUTH_EXTRA_ARGUMENTS_OVERRIDE_ALLOWLIST to an iterable of configured extra-argument keys that may be replaced by matching request data values. #### auth_html() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Must return login HTML content returned by provider #### auth_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Must return redirect URL to auth provider #### authenticate(\*args, \*\*kwargs) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) Authenticate user using social credentials Authentication is made if this is the correct backend, backend verification is made by kwargs inspection for current backend name presence. #### complete(\*args, \*\*kwargs) → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) #### continue_disconnect_pipeline(partial: [PartialMixin](#social_core.storage.PartialMixin)) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) Continue a halted disconnect with its effective request data. #### continue_pipeline(partial: [PartialMixin](#social_core.storage.PartialMixin)) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) Continue previous halted pipeline #### disconnect(\*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) #### extra_data(user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None), uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any], details: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any], pipeline_kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] Return default extra data to store in extra_data field #### get_association_state() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return the token from a prepared, user-bound authorization context. #### get_group_mappings() Enumerate independently managed membership sources. #### get_group_setting(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response, default=None) Resolve group configuration for this provider (or a SAML IdP). #### get_group_source(response) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Identify the provider’s active membership source. #### get_json(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), method: Literal['GET', 'POST', 'DELETE'] = 'GET', headers: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None, data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, json: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, auth: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | AuthBase | [None](https://docs.python.org/3/builtins/constants.html#None) = None, params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, timeout: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'user_info') → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[Any, Any] #### get_key_and_secret() → [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return tuple with Consumer Key and Consumer Secret for current service provider. Must return (key, secret), order *must* be respected. #### get_key_and_secret_basic_auth() → [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes) Generate HTTP Basic Authentication header value from KEY and SECRET. Returns: : Basic authentication value in the format b”Basic ” #### get_legacy_user_ids(details, response) → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return current values of identifiers used by older releases. #### get_querystring(url, \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### get_refresh_token(extra_data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) Select a stored renewal credential, or None when renewal is unavailable. Backends that exchange an access token should override this method. #### get_refresh_token_kwargs(extra_data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return default refresh arguments from stored account credentials. #### get_user(user_id) Return user with given ID from the User model used by this backend. This is called by django.contrib.auth.middleware. #### get_user_details(response) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return provider-supplied user details in a known internal structure. Leave name conversion to the social_names pipeline step. The returned dictionary can contain: `username` : Username, if any. `email` : User email, if any. `fullname` : User full name, if any. `first_name` : User first name, if any. `last_name` : User last name, if any. #### get_user_groups(response) → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) Return normalized external memberships, or None when disabled. #### get_user_id(details, response) Return a unique ID for the current user, by default from server response or details. #### get_user_id_for_key(details, response, id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Return a user identifier selected by an explicit response key. #### get_user_id_from_sources(\*sources: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None), id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Return the selected user ID from mappings or fail clearly. Sources are searched in order for the configured or explicitly passed ID key. Missing, `None`, and empty-string values are rejected. #### get_user_names(fullname='', first_name='', last_name='') #### icon *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### id_key() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return the ID_KEY to use for this backend, checking settings first. #### log_debug(message, \*args) → [None](https://docs.python.org/3/builtins/constants.html#None) #### log_warning(message, \*args) → [None](https://docs.python.org/3/builtins/constants.html#None) #### name *= ''* #### pipeline(pipeline, pipeline_index: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, \*args, \*\*kwargs) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) #### *property* pipeline_type *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* Type of the currently executing pipeline, saved with its partials. #### prepare_auth(user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [None](https://docs.python.org/3/builtins/constants.html#None) Bind association-only authorization to an authenticated local user. #### process_error(data, , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'callback') → [None](https://docs.python.org/3/builtins/constants.html#None) Hook to process provider response errors. Default implementation is a no-op. Backends that can detect provider-specific error payloads should override this method and raise an appropriate exception when needed. #### request(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), , method: Literal['GET', 'POST', 'DELETE'] = 'GET', headers: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None, data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, json: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, auth: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | AuthBase | [None](https://docs.python.org/3/builtins/constants.html#None) = None, params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, timeout: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'user_info') → Response #### require_association_user(user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None), , stage: ErrorStage = 'user_info') → [UserProtocol](#social_core.storage.UserProtocol) Require an authenticated local user for an association-only flow. #### run_pipeline(pipeline: [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)], pipeline_index=0, \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) #### setting(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), default=None) Return setting value from strategy #### start() → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) #### supports_inactive_user *= False* #### title *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### uses_redirect() → [bool](https://docs.python.org/3/builtins/functions.html#bool) Return True if this provider uses redirect url method, otherwise return false. #### validate_association_state(request_state: Any, user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Validate and consume authorization state bound to the current user. #### validate_partial_pipeline(partial: [PartialMixin](#social_core.storage.PartialMixin), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [None](https://docs.python.org/3/builtins/constants.html#None) Validate backend-specific requirements before resuming a pipeline. ### *class* social_core.backends.oauth.BaseOAuth1(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`OAuthAuth`](#social_core.backends.oauth.OAuthAuth) Consumer based mechanism OAuth authentication, fill the needed parameters to communicate properly with authentication service. URLs settings: : REQUEST_TOKEN_URL Request token URL #### OAUTH_TOKEN_PARAMETER_NAME *= 'oauth_token'* #### REDIRECT_URI_PARAMETER_NAME *= 'redirect_uri'* #### REQUEST_TOKEN_METHOD *: Literal['GET', 'POST']* *= 'GET'* #### REQUEST_TOKEN_URL *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* *= ''* #### UNATHORIZED_TOKEN_SUFIX *= 'unauthorized_token_name'* #### access_token(token: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return request for access token value #### auth_complete(\*args, \*\*kwargs) Return user, might be logged in #### auth_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return redirect url #### do_auth(access_token, \*args, \*\*kwargs) Finish the auth process once the access_token was retrieved #### get_unauthorized_token() #### oauth_auth(token: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, oauth_verifier=None, signature_type='AUTH_HEADER', , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'callback') #### oauth_authorization_request(token) Generate OAuth request to authorize token. #### oauth_request(token: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict), url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), params=None, method: Literal['GET', 'POST'] = 'GET') → Response Generate OAuth request, setups callback url #### process_error(data, , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'callback') → [None](https://docs.python.org/3/builtins/constants.html#None) Hook to process provider response errors. Default implementation is a no-op. Backends that can detect provider-specific error payloads should override this method and raise an appropriate exception when needed. #### request_token_extra_arguments() → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return extra arguments needed on request-token process #### set_unauthorized_token() #### unauthorized_token() Return request for unauthorized token (first stage) #### user_data(access_token: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict), \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) Loads user data from service. Implement in subclass ### *class* social_core.backends.oauth.BaseOAuth2(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`OAuthAuth`](#social_core.backends.oauth.OAuthAuth) Base class for OAuth2 providers. OAuth2 details at: : [https://datatracker.ietf.org/doc/html/rfc6749](https://datatracker.ietf.org/doc/html/rfc6749) #### REDIRECT_STATE *= True* #### REFRESH_TOKEN_METHOD *: Literal['GET', 'POST', 'DELETE']* *= 'POST'* #### REFRESH_TOKEN_URL *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### RESPONSE_TYPE *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= 'code'* #### STATE_PARAMETER *= True* #### USE_BASIC_AUTH *= False* #### auth_complete(\*args, \*\*kwargs) Completes login process, must return user instance #### auth_complete_credentials() #### auth_complete_params(state=None) #### auth_headers() → Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)] #### auth_params(state: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### auth_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return redirect url #### do_auth(access_token, \*args, \*\*kwargs) Finish the auth process once the access_token was retrieved #### extra_data(user, uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], details: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], pipeline_kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return access_token, token_type, and extra defined names to store in extra_data field #### get_access_token(response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Extract a usable access token before profile lookup or pipeline execution. #### process_error(data, , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'callback') → [None](https://docs.python.org/3/builtins/constants.html#None) Hook to process provider response errors. Default implementation is a no-op. Backends that can detect provider-specific error payloads should override this method and raise an appropriate exception when needed. #### process_refresh_token_response(response, \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) #### refresh_token(token: [str](https://docs.python.org/3/builtins/stdtypes.html#str), \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) #### refresh_token_auth() → AuthBase | [None](https://docs.python.org/3/builtins/constants.html#None) #### refresh_token_params(token: [str](https://docs.python.org/3/builtins/stdtypes.html#str), \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### refresh_token_url() #### request_access_token(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), method: Literal['GET', 'POST', 'DELETE'] = 'GET', headers: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None, data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, json: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, auth: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | AuthBase | [None](https://docs.python.org/3/builtins/constants.html#None) = None, params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, , stage: ErrorStage = 'token_exchange') → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[Any, Any] #### use_basic_auth() → [bool](https://docs.python.org/3/builtins/functions.html#bool) #### user_data(access_token: [str](https://docs.python.org/3/builtins/stdtypes.html#str), \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) Loads user data from service. Implement in subclass ### *class* social_core.backends.oauth.BaseOAuth2PKCE(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`BaseOAuth2`](#social_core.backends.oauth.BaseOAuth2) Base class for providers using OAuth2 with Proof Key for Code Exchange (PKCE). OAuth2 details at: : [https://datatracker.ietf.org/doc/html/rfc6749](https://datatracker.ietf.org/doc/html/rfc6749) PKCE details at: : [https://datatracker.ietf.org/doc/html/rfc7636](https://datatracker.ietf.org/doc/html/rfc7636) #### DEFAULT_USE_PKCE *= True* #### PKCE_DEFAULT_CODE_CHALLENGE_METHOD *= 'S256'* #### PKCE_DEFAULT_CODE_VERIFIER_LENGTH *= 43* #### auth_complete_params(state=None) #### auth_params(state=None) #### create_code_verifier() #### generate_code_challenge(code_verifier, challenge_method) #### get_code_verifier() ### *class* social_core.backends.oauth.OAuthAuth(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`BaseAuth`](#social_core.backends.base.BaseAuth) OAuth authentication backend base class. Settings will be inspected to get more values names that should be stored on extra_data field. The setting name is created following the pattern SOCIAL_AUTH__EXTRA_DATA. access_token is always stored. URLs settings: : AUTHORIZATION_URL Authorization service url ACCESS_TOKEN_URL Access token URL #### ACCESS_TOKEN_METHOD *: Literal['GET', 'POST']* *= 'POST'* #### ACCESS_TOKEN_PAYLOAD *: Literal['form', 'json']* *= 'form'* #### ACCESS_TOKEN_URL *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* *= ''* #### AUTHORIZATION_URL *= ''* #### DEFAULT_SCOPE *: [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### ID_KEY *= 'id'* #### REDIRECT_STATE *= False* #### REVOKE_TOKEN_METHOD *: Literal['GET', 'POST', 'DELETE']* *= 'POST'* #### REVOKE_TOKEN_URL *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* *= ''* #### SCOPE_PARAMETER_NAME *= 'scope'* #### SCOPE_SEPARATOR *= ' '* #### STATE_PARAMETER *= False* #### access_token_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### authorization_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### extra_data(user, uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], details: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], pipeline_kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return access_token and extra defined names to store in extra_data field #### get_access_token_url_format() → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### get_authorization_url_format() → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### get_or_create_state() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) #### get_redirect_uri(state: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Build redirect with redirect_state parameter. #### get_request_state() #### get_scope() → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return list with needed access scope #### get_scope_argument() #### get_session_state() #### process_revoke_token_response(response) #### revoke_token(token, uid) #### revoke_token_headers(token, uid) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] #### revoke_token_params(token, uid) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] #### revoke_token_url(token, uid) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### state_token() Generate csrf token to include as state parameter. #### user_data(access_token, \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) Loads user data from service. Implement in subclass #### validate_state() Validate state value. Raises exception on error, returns state value if valid. ### *class* social_core.backends.open_id.OpenIdAuth(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`BaseAuth`](#social_core.backends.base.BaseAuth) Generic OpenID authentication backend #### PROTOCOL_ID_KEY *= 'identity_url'* #### URL *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### USERNAME_KEY *= 'username'* #### auth_complete(\*args, \*\*kwargs) Complete auth process #### auth_html() Return auth HTML returned by service #### auth_url() Return auth URL returned by service #### consumer() Create an OpenID Consumer object for the given Django request. #### continue_pipeline(partial) Continue previous halted pipeline #### create_consumer(store=None) #### extra_data(user, uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], details: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], pipeline_kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return defined extra data names to store in extra_data field. Settings will be inspected to get more values names that should be stored on extra_data field. Setting name is created from current backend name (all uppercase) plus \_SREG_EXTRA_DATA and \_AX_EXTRA_DATA because values can be returned by SimpleRegistration or AttributeExchange schemas. Both list must be a value name and an alias mapping similar to SREG_ATTR, OLD_AX_ATTRS or AX_SCHEMA_ATTRS #### get_ax_attributes() → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)]] #### get_consumer_store() → OpenIdStore | [None](https://docs.python.org/3/builtins/constants.html#None) #### get_return_to() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### get_sreg_attributes() #### get_user_details(response) Return user details from an OpenID request #### get_user_id(details, response) Return the protocol-defined identity URL provided by the service. OpenID identity is asserted as a URL rather than a response mapping field, so the configurable ID_KEY does not apply to this backend. #### get_user_id_for_key(details, response, id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Return the asserted identity URL or an explicitly selected profile field. #### name *= 'openid'* #### openid_request(params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Return openid request #### openid_url() Return service provider URL. This base class is generic accepting a POST parameter that specifies provider URL. #### process_error(data, , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'callback') → [None](https://docs.python.org/3/builtins/constants.html#None) Hook to process provider response errors. Default implementation is a no-op. Backends that can detect provider-specific error payloads should override this method and raise an appropriate exception when needed. #### setup_request(params=None) Setup request #### title *= 'OpenID'* #### trust_root() Return trust-root option #### uses_redirect() Return true if openid request will be handled with redirect or HTML content will be returned. #### values_from_response(response, sreg_names=None, ax_names=None) Return values from SimpleRegistration response or AttributeExchange response if present. @sreg_names and @ax_names must be a list of name and aliases for such name. The alias will be used as mapping key. ### *class* social_core.backends.open_id_connect.OpenIdConnectAssociation(handle, secret='', issued=0, lifetime=0, assoc_type='') Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) Use Association model to save the nonce by force. ### *class* social_core.backends.open_id_connect.OpenIdConnectAuth(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`BaseOAuth2PKCE`](#social_core.backends.oauth.BaseOAuth2PKCE) Base class for Open ID Connect backends. Currently only the code response type is supported. It can also be directly instantiated as a generic OIDC backend. To use it you will need to set at minimum: SOCIAL_AUTH_OIDC_OIDC_ENDPOINT = ‘[https://](https://)…..’ # endpoint without /.well-known/openid-configuration SOCIAL_AUTH_OIDC_KEY = ‘’ SOCIAL_AUTH_OIDC_SECRET = ‘’ SOCIAL_AUTH_OIDC_USE_PKCE = True # optional, enables PKCE for this backend #### ACCESS_TOKEN_URL *= ''* #### ACR_VALUES *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### AUTHORIZATION_URL *= ''* #### CUSTOM_AT_HASH_ALGO *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### DEFAULT_SCOPE *= ['openid', 'profile', 'email']* #### DEFAULT_USE_PKCE *= False* #### DISPLAY *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### EMAIL_KEY *= 'email'* #### EXTRA_DATA *= ['id_token', 'refresh_token', ('sub', 'id')]* #### FIRST_NAME_KEY *= 'given_name'* #### FULLNAME_KEY *= 'name'* #### ID_KEY *= 'sub'* #### ID_TOKEN_HINT *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### ID_TOKEN_ISSUER *= ''* #### ID_TOKEN_MAX_AGE *= 600* #### JWKS_URI *= ''* #### JWT_ALGORITHMS *= ['RS256']* #### JWT_DECODE_OPTIONS *: Options* *= {}* #### JWT_LEEWAY *: [float](https://docs.python.org/3/builtins/functions.html#float)* *= 1.0* #### LAST_NAME_KEY *= 'family_name'* #### LOGIN_HINT *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### MAX_AGE *: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### NONCE_LIFETIME *= 1800* #### OIDC_ENDPOINT *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### PKCE_DEFAULT_CODE_CHALLENGE_METHOD *= 'S256'* #### PROMPT *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### REDIRECT_STATE *= False* #### REVOKE_TOKEN_METHOD *: Literal['GET', 'POST', 'DELETE']* *= 'GET'* #### REVOKE_TOKEN_URL *= ''* #### TOKEN_ENDPOINT_AUTH_METHOD *= ''* #### UI_LOCALES *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### USERINFO_URL *= ''* #### USERNAME_KEY *= 'preferred_username'* #### USE_NONCE *= True* #### VALIDATE_AT_HASH *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* *= True* #### access_token_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### auth_params(state=None) Return extra arguments needed on auth process. #### authorization_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### *static* calc_at_hash(access_token, algorithm, custom_at_hash_algo: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Calculates “at_hash” claim which is not done by pyjwt. Custom “at_hash” algorithm is used for non-standard token. See [https://pyjwt.readthedocs.io/en/stable/usage.html#oidc-login-flow](https://pyjwt.readthedocs.io/en/stable/usage.html#oidc-login-flow) See [https://github.com/python-social-auth/social-core/issues/1306](https://github.com/python-social-auth/social-core/issues/1306) #### continue_pipeline(partial: [PartialMixin](#social_core.storage.PartialMixin)) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) Continue previous halted pipeline #### decode_and_validate_id_token(id_token, access_token) Validate an ID token’s signature and self-contained claims. #### extra_data(user, uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), response: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], details: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], pipeline_kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return access_token, token_type, and extra defined names to store in extra_data field #### find_valid_key(id_token) #### get_and_store_nonce(url, state) #### get_jwks_keys(\*args, \*\*kwargs) #### get_nonce(nonce) #### get_remote_jwks_keys() #### get_setting_config(setting_name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), oidc_name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), default: [str](https://docs.python.org/3/builtins/stdtypes.html#str), , stage: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown'] = 'begin') → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### get_user_details(response) Return user details from the UserInfo response or ID token. #### get_user_groups(response) → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) Return normalized external memberships, or None when disabled. #### get_user_id(details, response) Return a unique ID for the current user, by default from server response or details. #### *static* id_token_audiences(audience) → [set](https://docs.python.org/3/builtins/stdtypes.html#set)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### id_token_issuer() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### jwks_uri() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### name *= 'oidc'* #### oidc_config(\*args, \*\*kwargs) #### oidc_endpoint() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### pipeline(pipeline, pipeline_index: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, \*args, \*\*kwargs) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) #### process_refresh_token_response(response, \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) #### remove_nonce(nonce_id) → [None](https://docs.python.org/3/builtins/constants.html#None) #### request_access_token(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), method: Literal['GET', 'POST', 'DELETE'] = 'GET', headers: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None, data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, json: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, auth: [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | AuthBase | [None](https://docs.python.org/3/builtins/constants.html#None) = None, params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, , stage: ErrorStage = 'token_exchange') → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[Any, Any] Retrieve the access token. Also, validate the id_token and store it (temporarily). #### revoke_token_url(token, uid) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### title *= 'OpenID Connect'* #### use_basic_auth() → [bool](https://docs.python.org/3/builtins/functions.html#bool) #### user_data(access_token: [str](https://docs.python.org/3/builtins/stdtypes.html#str), \*args, \*\*kwargs) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) Loads user data from service. Implement in subclass #### userinfo_url() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### validate_and_return_id_token(id_token, access_token) Validates the id_token according to the steps at [http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation](http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation). #### validate_and_return_refresh_id_token(id_token, access_token) Validate an ID token returned by a refresh request. #### validate_at_hash(claims, access_token, key) Validate the ‘at_hash’ claim according to OpenID Connect specs. See: [https://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken](https://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken) #### validate_authorized_party(claims, client_id: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [None](https://docs.python.org/3/builtins/constants.html#None) Validate the client authorized to use the ID token. #### validate_claims(id_token) → [None](https://docs.python.org/3/builtins/constants.html#None) #### validate_refresh_id_token_claims(previous, current) → [None](https://docs.python.org/3/builtins/constants.html#None) Validate identity continuity for an ID token refresh. #### validate_required_id_token_claims(claims) → [None](https://docs.python.org/3/builtins/constants.html#None) Validate claims required in every ID token. #### validate_temporal_claims(id_token) → [None](https://docs.python.org/3/builtins/constants.html#None) #### validate_userinfo_sub(userinfo: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None)) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) Validate that UserInfo belongs to the validated ID token subject. ## Pipeline ### social_core.pipeline.social_auth.associate_by_email(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) Associate current auth with a user with the same email address in the DB. This pipeline entry is not 100% secure unless you know that the providers enabled enforce email verification on their side, otherwise a user can attempt to take over another user account by using the same (not validated) email address on some provider. This pipeline entry is disabled by default. ### social_core.pipeline.social_auth.associate_user(backend: [BaseAuth](#social_core.backends.base.BaseAuth), uid, user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, social=None, \*args, id_key='', legacy_uids=(), \*\*kwargs) ### social_core.pipeline.social_auth.auth_allowed(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, response, \*args, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) ### social_core.pipeline.social_auth.load_extra_data(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, response, uid, user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) ### social_core.pipeline.social_auth.social_details(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, response, \*args, \*\*kwargs) ### social_core.pipeline.social_auth.social_names(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, \*args, \*\*kwargs) Populate missing full or component names using provider details. ### social_core.pipeline.social_auth.social_uid(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, response, \*args, \*\*kwargs) ### social_core.pipeline.social_auth.social_user(backend: [BaseAuth](#social_core.backends.base.BaseAuth), uid, user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, id_key='', legacy_uids=(), \*\*kwargs) ### social_core.pipeline.user.create_user(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy), details, backend: [BaseAuth](#social_core.backends.base.BaseAuth), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) ### social_core.pipeline.user.get_username(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy), details, backend: [BaseAuth](#social_core.backends.base.BaseAuth), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) ### social_core.pipeline.user.sync_groups(strategy, backend, response, user=None, groups=None, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) Synchronize local memberships through the application’s strategy. ### social_core.pipeline.user.user_details(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy), details, backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) Update user details using data from provider. ### social_core.pipeline.mail.mail_validation(backend: [BaseAuth](#social_core.backends.base.BaseAuth), details, is_new=False, \*args, \*\*kwargs) ## Framework integration ### *class* social_core.strategy.BaseStrategy(storage: [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseStorage](#social_core.storage.BaseStorage)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None, tpl: [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseTemplateStrategy](#social_core.strategy.BaseTemplateStrategy)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### ALLOWED_CHARS *= 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'* #### DEFAULT_TEMPLATE_STRATEGY alias of [`BaseTemplateStrategy`](#social_core.strategy.BaseTemplateStrategy) #### SESSION_SAVE_KEY *= 'psa_session_id'* #### absolute_uri(path: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### authenticate(backend: [BaseAuth](#social_core.backends.base.BaseAuth), \*args, \*\*kwargs) → [UserProtocol](#social_core.storage.UserProtocol) | [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) Trigger the authentication mechanism tied to the current framework #### build_absolute_uri(path: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Build absolute URI with given (optional) path #### clean_authenticate_args(\*args, \*\*kwargs) Take authenticate arguments and return a “cleaned” version of them #### clean_partial_pipeline(token) → [None](https://docs.python.org/3/builtins/constants.html#None) #### create_user(\*args, \*\*kwargs) #### from_session_value(val) #### get_backend(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), redirect_uri: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*\*kwargs) → [BaseAuth](#social_core.backends.base.BaseAuth) Return a configured backend instance #### get_backend_class(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseAuth](#social_core.backends.base.BaseAuth)] Return a configured backend class #### get_backends() → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return configured backends #### get_disconnect_pipeline(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### get_language() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return current language #### get_pipeline(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] #### get_request_data(merge: [bool](https://docs.python.org/3/builtins/functions.html#bool) = True) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return data from the current framework request (POST or GET). #### get_session_id() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) Return session ID to be used by restore_session. #### get_setting(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Return value for given setting name #### get_storage(, stage: ErrorStage) → [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseStorage](#social_core.storage.BaseStorage)] Resolve storage while reporting failures at the calling operation. #### get_user(\*args, \*\*kwargs) #### html(content: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) Return HTTP response with given content #### openid_session_dict(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → OpenIdSessionWrapper #### openid_store() → OpenIdStore #### partial_load(token: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [PartialMixin](#social_core.storage.PartialMixin) | [None](https://docs.python.org/3/builtins/constants.html#None) #### partial_pipeline_external_resume_confirmation(backend: [BaseAuth](#social_core.backends.base.BaseAuth), partial: [PartialMixin](#social_core.storage.PartialMixin), request_data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any]) → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) #### partial_pipeline_external_resume_confirmed(backend: [BaseAuth](#social_core.backends.base.BaseAuth), request_data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any]) → [bool](https://docs.python.org/3/builtins/functions.html#bool) #### pipeline_request_data(data: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None)) → Iterator[[None](https://docs.python.org/3/builtins/constants.html#None)] Scope effective request data to one pipeline execution. #### random_string(length: [int](https://docs.python.org/3/builtins/functions.html#int) = 12, chars: [str](https://docs.python.org/3/builtins/stdtypes.html#str) = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789') → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### redirect(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) Return a response redirect to the given URL #### render_html(tpl: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, html: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Render given template or raw html with given context #### request_data(merge: [bool](https://docs.python.org/3/builtins/functions.html#bool) = True) → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] Return effective pipeline data, or data from the current request. During a partial resume, merge does not change the replayed mapping. Use get_request_data(), request_get(), or request_post() to read the current framework request without replayed data. #### request_get() Request GET data #### request_host() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return current host value #### request_is_secure() → [bool](https://docs.python.org/3/builtins/functions.html#bool) Is the request using HTTPS? #### request_path() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) path of the current request #### request_port() → [int](https://docs.python.org/3/builtins/functions.html#int) Port in use for this request #### request_post() Request POST data #### restore_session(session_id: [str](https://docs.python.org/3/builtins/stdtypes.html#str), kwargs: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [None](https://docs.python.org/3/builtins/constants.html#None) Restores session and updates kwargs to match it. This is only called if get_session_id returns a value. #### send_email_validation(backend: [BaseAuth](#social_core.backends.base.BaseAuth), email: [str](https://docs.python.org/3/builtins/stdtypes.html#str), partial_token: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [CodeMixin](#social_core.storage.CodeMixin) #### session_get(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), default=None) Return session value for given key #### session_pop(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Pop session value for given key #### session_set(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), value) Set session value for given key #### session_setdefault(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), value) #### setting(name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), default=None, backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) #### *property* storage *: [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseStorage](#social_core.storage.BaseStorage)]* #### sync_user_groups(user, groups: [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None), , backend: [BaseAuth](#social_core.backends.base.BaseAuth), response, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) Override to apply configured external memberships to local groups. #### to_session_value(val) #### validate_email(email: [str](https://docs.python.org/3/builtins/stdtypes.html#str), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [bool](https://docs.python.org/3/builtins/functions.html#bool) ### *class* social_core.strategy.BaseTemplateStrategy(strategy) Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### render(tpl: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, html: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### render_string(html: [str](https://docs.python.org/3/builtins/stdtypes.html#str), context: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### render_template(tpl: [str](https://docs.python.org/3/builtins/stdtypes.html#str), context: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) ### *class* social_core.strategy.HttpResponseProtocol(\*args, \*\*kwargs) Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol) #### *property* url *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* Models mixins for Social Auth ### *class* social_core.storage.AssociationMixin Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) OpenId account association #### assoc_type *= ''* #### *classmethod* get(server_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, handle: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Get an Association instance #### handle *= ''* #### is_expired(now: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Return whether the association’s lifetime has elapsed. #### issued *= 0* #### lifetime *= 0* #### *classmethod* oids(server_url, handle=None) #### *classmethod* openid_association(assoc) #### *classmethod* remove(ids_to_delete) Remove an Association instance #### secret *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)* *= ''* #### server_url *= ''* #### *classmethod* store(server_url, association) Create an Association instance ### *class* social_core.storage.BaseStorage Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### association alias of [`AssociationMixin`](#social_core.storage.AssociationMixin) #### code alias of [`CodeMixin`](#social_core.storage.CodeMixin) #### *classmethod* is_integrity_error(exception) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Check if given exception flags an integrity error in the DB #### nonce alias of [`NonceMixin`](#social_core.storage.NonceMixin) #### partial alias of [`PartialMixin`](#social_core.storage.PartialMixin) #### user alias of [`UserMixin`](#social_core.storage.UserMixin) ### *class* social_core.storage.CodeMixin Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### code *= ''* #### email *= ''* #### *classmethod* generate_code() #### *classmethod* get_code(code) #### is_expired(seconds: [int](https://docs.python.org/3/builtins/functions.html#int)) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Return whether the code has reached its lifetime, or has no timestamp. #### *classmethod* make_code(email: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [CodeMixin](#social_core.storage.CodeMixin) #### *abstractmethod* save() #### timestamp *: [datetime](https://docs.python.org/3/library/datetime.html#datetime.datetime) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### verified *= False* #### verify() → [None](https://docs.python.org/3/builtins/constants.html#None) ### *class* social_core.storage.NonceMixin Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) One use numbers #### *classmethod* delete(nonce) Delete a Nonce instance #### *classmethod* get(server_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), salt: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Retrieve a Nonce instance #### salt *= ''* #### server_url *= ''* #### timestamp *= 0* #### *classmethod* use(server_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), timestamp, salt: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Create a Nonce instance ### *class* social_core.storage.PartialMixin Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### *property* args #### backend *= ''* #### data *: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]* *= {}* #### *classmethod* destroy(token: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) #### extend_kwargs(values) → [None](https://docs.python.org/3/builtins/constants.html#None) #### *classmethod* generate_token() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) #### *property* kwargs #### *classmethod* load(token: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [PartialMixin](#social_core.storage.PartialMixin) | [None](https://docs.python.org/3/builtins/constants.html#None) #### next_step *: [int](https://docs.python.org/3/builtins/functions.html#int)* #### *property* pipeline_type *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* Legacy partials may resume authentication, but never disconnect. #### *classmethod* prepare(backend: [str](https://docs.python.org/3/builtins/stdtypes.html#str), next_step: [int](https://docs.python.org/3/builtins/functions.html#int), data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]) → [PartialMixin](#social_core.storage.PartialMixin) #### *property* request_data *: [Mapping](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None)* Effective data for a resume, including legacy partial snapshots. #### *abstractmethod* save() #### *classmethod* store(partial: [PartialMixin](#social_core.storage.PartialMixin)) → [PartialMixin](#social_core.storage.PartialMixin) #### token *= ''* ### *class* social_core.storage.PipelineUserProtocol(\*args, \*\*kwargs) Bases: [`UserProtocol`](#social_core.storage.UserProtocol), [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol) #### is_new *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* #### social_user *: [UserMixin](#social_core.storage.UserMixin) | [None](https://docs.python.org/3/builtins/constants.html#None)* ### *class* social_core.storage.UserMixin Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object) #### ACCESS_TOKEN_EXPIRED_THRESHOLD *= 5* #### *property* access_token *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* Return access_token stored in extra_data or None #### access_token_expired() Return true / false if access token is already expired #### *classmethod* allowed_to_disconnect(user: [UserProtocol](#social_core.storage.UserProtocol), backend_name: [str](https://docs.python.org/3/builtins/stdtypes.html#str), association_id=None) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Return if it’s safe to disconnect the social account for the given user #### *classmethod* changed(user: [UserProtocol](#social_core.storage.UserProtocol)) → [None](https://docs.python.org/3/builtins/constants.html#None) The given user instance is ready to be saved #### *classmethod* clean_username(value: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Clean username removing any unsupported character #### *classmethod* create_social_auth(user: [UserProtocol](#social_core.storage.UserProtocol), uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), provider: [str](https://docs.python.org/3/builtins/stdtypes.html#str), id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str) = '') Create a UserSocialAuth instance for given user #### *classmethod* create_user(\*args, \*\*kwargs) Create a user instance #### *classmethod* disconnect(entry) Disconnect the social account for the given user #### expiration_datetime() #### expiration_timedelta() → [timedelta](https://docs.python.org/3/library/datetime.html#datetime.timedelta) | [None](https://docs.python.org/3/builtins/constants.html#None) Return provider session live seconds. Returns a timedelta ready to use with session.set_expiry(). If provider returns a timestamp instead of session seconds to live, the timedelta is inferred from current time (using UTC timezone). Handles three types of expiration data: - expires_on: Always treated as absolute timestamp - expires_in: Always treated as relative seconds from auth_time - expires: Uses heuristic (>63072000 = 2 years) to distinguish timestamp vs relative #### extra_data *: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)]* #### get_access_token(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) Returns a valid access token. #### get_backend(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy)) → [type](https://docs.python.org/3/builtins/functions.html#type)[[BaseAuth](#social_core.backends.base.BaseAuth)] #### get_backend_instance(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy)) → [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) #### *classmethod* get_social_auth(provider: [str](https://docs.python.org/3/builtins/stdtypes.html#str), uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Return UserSocialAuth for given provider and uid #### *classmethod* get_social_auth_by_extra_data(provider: [str](https://docs.python.org/3/builtins/stdtypes.html#str), key: [str](https://docs.python.org/3/builtins/stdtypes.html#str), value: [str](https://docs.python.org/3/builtins/stdtypes.html#str), id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str) = '') Return an unambiguous association matching stored provider data. #### *classmethod* get_social_auth_for_user(user: [UserProtocol](#social_core.storage.UserProtocol), provider: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, id: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Return all the UserSocialAuth instances for given user #### *classmethod* get_user(pk) Return user instance for given id #### *classmethod* get_username(user: [UserProtocol](#social_core.storage.UserProtocol)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Return the username for given user #### *classmethod* get_users_by_email(email: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Return users instances for given email address #### id_key *= ''* #### *classmethod* migrate_social_auth(social, uid: [str](https://docs.python.org/3/builtins/stdtypes.html#str), id_key: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) Atomically replace an association’s identifier and identifier key. #### provider *= ''* #### refresh_token(strategy: [BaseStrategy](#social_core.strategy.BaseStrategy), \*args, \*\*kwargs) → [None](https://docs.python.org/3/builtins/constants.html#None) Renew stored credentials using the backend’s selected token. Missing renewal credentials require reauthentication only when the stored access token is known to have expired. Otherwise no request is sent. Backends without a refresh method are left unchanged. #### *abstractmethod* save() #### set_extra_data(extra_data: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [bool](https://docs.python.org/3/builtins/functions.html#bool) #### uid *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* #### user *: [UserProtocol](#social_core.storage.UserProtocol)* #### *classmethod* user_exists(\*args, \*\*kwargs) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Return True/False if a User instance exists with the given arguments. Arguments are directly passed to filter() manager method. #### *classmethod* user_model() → [type](https://docs.python.org/3/builtins/functions.html#type)[[UserProtocol](#social_core.storage.UserProtocol)] Return the user model #### *classmethod* username_max_length() → [int](https://docs.python.org/3/builtins/functions.html#int) Return the max length for username ### *class* social_core.storage.UserProtocol(\*args, \*\*kwargs) Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol) #### *property* id *: [int](https://docs.python.org/3/builtins/functions.html#int)* #### *property* is_active *: [bool](https://docs.python.org/3/builtins/functions.html#bool) | Callable[[], [bool](https://docs.python.org/3/builtins/functions.html#bool)]* #### *property* is_authenticated *: [bool](https://docs.python.org/3/builtins/functions.html#bool) | Callable[[], [bool](https://docs.python.org/3/builtins/functions.html#bool)]* #### *property* username *: [str](https://docs.python.org/3/builtins/stdtypes.html#str)* ## Errors and utilities Authentication failures with stable, framework-independent recovery metadata. ### *exception* social_core.exceptions.AuthAssociationError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) A local account or stored authentication identity conflicts. #### default_code *= 'identity_in_use'* ### *exception* social_core.exceptions.AuthCanceled(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) Authorization was explicitly declined or canceled. #### default_code *= 'authorization_declined'* ### *exception* social_core.exceptions.AuthConfigurationError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`SocialAuthBaseException`](#social_core.exceptions.SocialAuthBaseException) The integration needs configuration or implementation changes. #### default_code *= 'invalid_setting'* ### *exception* social_core.exceptions.AuthCredentialError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) Credentials were rejected or another provider login is required. #### default_code *= 'credential_rejected'* ### *exception* social_core.exceptions.AuthException(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`SocialAuthBaseException`](#social_core.exceptions.SocialAuthBaseException) Broad catch boundary for authentication-flow failures. ### *exception* social_core.exceptions.AuthInputError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) The application or browser supplied missing or invalid input. #### default_code *= 'invalid_parameter'* ### *exception* social_core.exceptions.AuthPolicyError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) A local authentication or disconnect policy rejected the operation. #### default_code *= 'authentication_disallowed'* ### *exception* social_core.exceptions.AuthProviderError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) A provider request failed at the transport or HTTP boundary. #### default_code *= 'http_error'* ### *exception* social_core.exceptions.AuthResponseError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) A provider response cannot be parsed or validated. #### default_code *= 'malformed_response'* ### *exception* social_core.exceptions.AuthSessionError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) Authentication cannot be bound to its initiating session or user. #### default_code *= 'session_context_missing'* ### *exception* social_core.exceptions.AuthUnknownError(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`AuthException`](#social_core.exceptions.AuthException) The authentication failure has no known structured classification. ### *exception* social_core.exceptions.SocialAuthBaseException(backend: [BaseAuth](#social_core.backends.base.BaseAuth) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*details: [object](https://docs.python.org/3/builtins/functions.html#object), code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, source: ErrorSource | [None](https://docs.python.org/3/builtins/constants.html#None) = None, stage: ErrorStage = 'unknown', recovery: RecoveryAction | [None](https://docs.python.org/3/builtins/constants.html#None) = None, parameter: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, claim: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, provider_code: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, context: Mapping[[str](https://docs.python.org/3/builtins/stdtypes.html#str), Any] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) Bases: [`ValueError`](https://docs.python.org/3/builtins/exceptions.html#ValueError) Broad catch boundary for social-auth failures, including configuration. #### default_code *= 'unknown_error'* #### public_metadata() → [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Return non-identifying fields for client transports. #### source *: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['configuration', 'request', 'session', 'provider_response', 'local_policy', 'storage', 'unknown']* #### stage *: [Literal](https://docs.python.org/3/library/typing.html#typing.Literal)['begin', 'callback', 'token_exchange', 'token_validation', 'user_info', 'pipeline', 'refresh', 'disconnect', 'unknown']* ### *class* social_core.utils.PartialPipelineResult(partial: 'PartialMixin | None' = None, response: 'HttpResponseProtocol | None' = None, halt: 'bool' = False) #### halt *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* *= False* #### partial *: [PartialMixin](#social_core.storage.PartialMixin) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* #### response *: [HttpResponseProtocol](#social_core.strategy.HttpResponseProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* ### *class* social_core.utils.PartialPipelineSelection(token: 'str | None' = None, owns_token: 'bool' = False, pending_resume: 'bool' = False) #### owns_token *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* *= False* #### pending_resume *: [bool](https://docs.python.org/3/builtins/functions.html#bool)* *= False* #### token *: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)* *= None* ### social_core.utils.append_slash(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Make sure we append a slash at the end of the URL otherwise we have issues with urljoin Example: >>> urlparse.urljoin(’[http://www.example.com/api/v3](http://www.example.com/api/v3)’, ‘user/1/’) ‘[http://www.example.com/api/user/1/](http://www.example.com/api/user/1/)’ ### social_core.utils.build_absolute_uri(host_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), path: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Build absolute URI with given (optional) path ### *class* social_core.utils.cache(ttl: [int](https://docs.python.org/3/builtins/functions.html#int)) Cache decorator that caches the return value of a method for a specified time. It maintains a cache per class and method arguments, so subclasses have a different cache entry for the same cached method. Call `method.invalidate()` to clear all entries, or `method.invalidate(instance, *args, **kwargs)` to clear one entry. Call `method.refresh(instance, *args, **kwargs)` to replace one entry only after the underlying method succeeds. Failed refreshes propagate their exception and preserve the existing value and expiry time. #### cache *: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[type](https://docs.python.org/3/builtins/functions.html#type), [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[Any](https://docs.python.org/3/library/typing.html#typing.Any), ...], [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [Any](https://docs.python.org/3/library/typing.html#typing.Any)], ...]], [Any](https://docs.python.org/3/library/typing.html#typing.Any)]* ### social_core.utils.constant_time_compare(val1: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes), val2: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [bytes](https://docs.python.org/3/builtins/stdtypes.html#bytes)) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Compare two values and prevent timing attacks for cryptographic use. ### social_core.utils.drop_lists(value) ### social_core.utils.first(func, items) Return the first item in the list for what func returns True ### social_core.utils.get_allowed_redirect_schemes(backend: [BaseAuth](#social_core.backends.base.BaseAuth)) → [set](https://docs.python.org/3/builtins/stdtypes.html#set)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] ### social_core.utils.get_querystring(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) ### social_core.utils.get_strategy(strategy: [str](https://docs.python.org/3/builtins/stdtypes.html#str), storage: [str](https://docs.python.org/3/builtins/stdtypes.html#str), \*args, \*\*kwargs) → [BaseStrategy](#social_core.strategy.BaseStrategy) ### social_core.utils.handle_http_errors(func) Normalize raw HTTP errors from integrations outside BaseAuth.request. ### social_core.utils.http_error(backend: [BaseAuth](#social_core.backends.base.BaseAuth), error: requests.HTTPError, , stage: ErrorStage = 'user_info') → [SocialAuthBaseException](#social_core.exceptions.SocialAuthBaseException) Normalize a Requests HTTP failure, including errors without responses. ### social_core.utils.is_private_use_redirect(value: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None), allowed_schemes: Collection[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [bool](https://docs.python.org/3/builtins/functions.html#bool) Whether `value` uses a non-web scheme that has been explicitly allowed. URI construction helpers such as `build_absolute_uri` only preserve http and https, so callers must check this before turning a redirect candidate into an absolute URI. ### social_core.utils.is_url(value: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None), allowed_schemes: Collection[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [bool](https://docs.python.org/3/builtins/functions.html#bool) ### social_core.utils.module_member(name) ### social_core.utils.normalize_redirect_schemes(schemes: Collection[[str](https://docs.python.org/3/builtins/stdtypes.html#str)]) → [set](https://docs.python.org/3/builtins/stdtypes.html#set)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] URI schemes are case-insensitive, and urlparse lowercases them. ### social_core.utils.normalize_user_names(fullname: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = '', first_name: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = '', last_name: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = '', , firstlast_from_full: [bool](https://docs.python.org/3/builtins/functions.html#bool) = True, full_from_firstlast: [bool](https://docs.python.org/3/builtins/functions.html#bool) = True) → [tuple](https://docs.python.org/3/builtins/stdtypes.html#tuple)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] Fill missing name representations without replacing supplied names. ### social_core.utils.parse_qs(value) Like urlparse.parse_qs but transform list values to single items ### social_core.utils.partial_pipeline_data(backend: [BaseAuth](#social_core.backends.base.BaseAuth), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, partial_token: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, \*\*kwargs) → [PartialMixin](#social_core.storage.PartialMixin) | [None](https://docs.python.org/3/builtins/constants.html#None) ### social_core.utils.partial_pipeline_result(backend: [BaseAuth](#social_core.backends.base.BaseAuth), user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, partial_token: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, \*args, pipeline_type: [str](https://docs.python.org/3/builtins/stdtypes.html#str) = 'authentication', \*\*kwargs) → [PartialPipelineResult](#social_core.utils.PartialPipelineResult) ### social_core.utils.provider_error(backend: [BaseAuth](#social_core.backends.base.BaseAuth), data: [object](https://docs.python.org/3/builtins/functions.html#object), , stage: ErrorStage = 'callback', status_code: [int](https://docs.python.org/3/builtins/functions.html#int) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, retry_after: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [SocialAuthBaseException](#social_core.exceptions.SocialAuthBaseException) | [None](https://docs.python.org/3/builtins/constants.html#None) Classify structured protocol errors without inspecting descriptions. ### social_core.utils.sanitize_redirect(hosts: [list](https://docs.python.org/3/builtins/stdtypes.html#list)[[str](https://docs.python.org/3/builtins/stdtypes.html#str)], redirect_to: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | Any, allowed_schemes: Collection[[str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None) = None) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) Given a list of hostnames and an untrusted URL to redirect to, this method tests it to make sure it isn’t garbage/harmful and returns it, else returns None, similar as how’s it done on django.contrib.auth.views. `allowed_schemes` defaults to http and https. Deployments that need to hand control back to a native application can add a private-use URI scheme (RFC 8252) through the `ALLOWED_REDIRECT_SCHEMES` setting. ### social_core.utils.setting_name(\*names: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) ### social_core.utils.setting_url(backend: [BaseAuth](#social_core.backends.base.BaseAuth), \*names: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) ### social_core.utils.slugify(value) Converts to lowercase, removes non-word characters (alphanumerics and underscores) and converts spaces to hyphens. Also strips leading and trailing whitespace. ### social_core.utils.to_setting_name(\*names: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) ### social_core.utils.url_add_parameters(url: [str](https://docs.python.org/3/builtins/stdtypes.html#str), params: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)] | [None](https://docs.python.org/3/builtins/constants.html#None), \_unquote_query: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False) → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Adds parameters to URL, parameter will be repeated if already present ### social_core.utils.user_agent() → [str](https://docs.python.org/3/builtins/stdtypes.html#str) Builds a simple User-Agent string to send in requests ### social_core.utils.user_is_active(user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None)) → [bool](https://docs.python.org/3/builtins/functions.html#bool) ### social_core.utils.user_is_authenticated(user: [UserProtocol](#social_core.storage.UserProtocol) | [None](https://docs.python.org/3/builtins/constants.html#None)) → [bool](https://docs.python.org/3/builtins/functions.html#bool) ### social_core.utils.wrap_access_token_error(backend: [BaseAuth](#social_core.backends.base.BaseAuth), , stage: ErrorStage = 'token_exchange') Normalize token request HTTP errors without guessing their cause.