jira.client.JiraCookieAuth

class documentation

class JiraCookieAuth(AuthBase): (source)

Jira Cookie Authentication. Allows using cookie authentication as described by `jira api docs <https://developer.atlassian.com/server/jira/platform/cookie-based-authentication/>`_

Method	`__call__`	Undocumented
Method	`__init__`	Cookie Based Authentication.
Method	`handle_401`	Refresh cookies if the session cookie has expired. Then retry the request.
Method	`init_session`	Initialise the Session object's cookies, so we can use the session cookie.
Method	`process_original_request`	Undocumented
Method	`send_request`	Undocumented
Method	`update_cookies`	Undocumented
Property	`cookies`	Undocumented
Method	`_increment_401_retry_counter`	Undocumented
Method	`_reset_401_retry_counter`	Undocumented
Instance Variable	`__auth`	Undocumented
Instance Variable	`_max_allowed_401_retries`	Undocumented
Instance Variable	`_retry_counter_401`	Undocumented
Instance Variable	`_session`	Undocumented
Instance Variable	`_session_api_url`	Undocumented

def __call__(self, request: requests.PreparedRequest): (source) ¶

Undocumented

def __init__(self, session: ResilientSession, session_api_url: str, auth: Tuple[str, str]): (source) ¶

Cookie Based Authentication. Args: session (ResilientSession): The Session object to communicate with the API. session_api_url (str): The session api url to use. auth (Tuple[str, str]): The username, password tuple.

def handle_401(self, response: requests.Response, **kwargs) -> requests.Response: (source) ¶

Refresh cookies if the session cookie has expired. Then retry the request. Args: response (requests.Response): the response with the possible 401 to handle Returns: requests.Response

def init_session(self): (source) ¶

Initialise the Session object's cookies, so we can use the session cookie. Raises: HTTPError: if the post returns an erroring http response

def process_original_request(self, original_request: requests.PreparedRequest): (source) ¶

Undocumented

def send_request(self, request: requests.PreparedRequest): (source) ¶

Undocumented

def update_cookies(self, original_request: requests.PreparedRequest): (source) ¶

Undocumented

@property
cookies = (source) ¶

Undocumented

def _increment_401_retry_counter(self): (source) ¶

Undocumented