Method _get_auth_token

st2client/st2client/base.py:233–259

Retrieve a valid auth token. If caching is enabled, we will first try to retrieve cached token from a file system. If cached token is expired or not available, we will try to authenticate using the provided credentials and retrieve a new auth token.

(self, client, username, password, cache_token)

        return path

    def _get_auth_token(self, client, username, password, cache_token):
        """
        Retrieve a valid auth token.

        If caching is enabled, we will first try to retrieve cached token from a
        file system. If cached token is expired or not available, we will try to
        authenticate using the provided credentials and retrieve a new auth
        token.

        :rtype: ``str``
        """
        if cache_token:
            token = self._get_cached_auth_token(
                client=client, username=username, password=password
            )
        else:
            token = None
        if not token:
            # Token is either expired or not available
            token_obj = self._authenticate_and_retrieve_auth_token(
                client=client, username=username, password=password
            )

            self._cache_auth_token(token_obj=token_obj)
            token = token_obj.token

        return token

    def _get_cached_auth_token(self, client, username, password):
        """