dosubot[bot]
commented
1 month ago Hey there, @r13i! I'm here to help you with any bugs, questions, or contributions. Let's tackle this together while we wait for a human maintainer to join the conversation.
The HTTPError: Current user not permitted to use Confluence error raised by the ConfluenceReader from Llama Index, while the Atlassian Confluence SDK works fine with the same parameters, could be due to differences in how the authentication and permissions are handled between the two implementations.
In the ConfluenceReader class, the authentication can be done using OAuth2, API token, or basic authentication (username and password). If the parameters provided do not match the expected format or if there are missing permissions for the user, the ConfluenceReader might raise an HTTPError.
Here is a snippet from the ConfluenceReader class that shows the initialization and authentication process:
def __init__(
self,
base_url: str = None,
oauth2: Optional[Dict] = None,
cloud: bool = True,
api_token: Optional[str] = None,
user_name: Optional[str] = None,
password: Optional[str] = None,
) -> None:
if base_url is None:
raise ValueError("Must provide `base_url`")
self.base_url = base_url
try:
from atlassian import Confluence
except ImportError:
raise ImportError(
"`atlassian` package not found, please run `pip install"
" atlassian-python-api`"
)
self.confluence: Confluence = None
if oauth2:
self.confluence = Confluence(url=base_url, oauth2=oauth2, cloud=cloud)
else:
api_token = api_token or os.getenv(CONFLUENCE_API_TOKEN)
if api_token is not None:
self.confluence = Confluence(url=base_url, token=api_token, cloud=cloud)
else:
user_name = user_name or os.getenv(CONFLUENCE_USERNAME)
if user_name is None:
raise ValueError(
"Must set environment variable `CONFLUENCE_USERNAME` if oauth,"
" oauth2, or `CONFLUENCE_API_TOKEN` are not provided."
)
password = password or os.getenv(CONFLUENCE_PASSWORD)
if password is None:
raise ValueError(
"Must set environment variable `CONFLUENCE_PASSWORD` if oauth,"
" oauth2, or `CONFLUENCE_API_TOKEN` are not provided."
)
self.confluence = Confluence(
url=base_url, username=user_name, password=password, cloud=cloud
)Ensure that the parameters provided for authentication (OAuth2, API token, username, and password) are correct and that the user has the necessary permissions to access the Confluence instance. Additionally, verify that the base_url is correctly formatted and includes the /wiki suffix if required.
If the Atlassian Confluence SDK works fine with the same parameters, it might be worth checking if there are any differences in the permissions or scopes granted to the user when using the SDK versus the ConfluenceReader.
According to the Llama Index documentation, the base_url must end with /wiki, and the CONFLUENCE_PASSWORD should be an API token obtained from the Atlassian profile security settings. Ensure that these details are correctly configured:
The user needs to specify the base URL for a Confluence instance to initialize the ConfluenceReader - base URL needs to end with `/wiki`. The user can optionally specify OAuth 2.0 credentials to authenticate with the Confluence instance. If no credentials are specified, the loader will look for `CONFLUENCE_API_TOKEN` or `CONFLUENCE_USERNAME`/`CONFLUENCE_PASSWORD` environment variables to proceed with basic authentication. Keep in mind `CONFLUENCE_PASSWORD` is not your actual password, but an API Token obtained here: https://id.atlassian.com/manage-profile/security/api-tokens.Make sure to follow these guidelines to avoid the HTTPError [1][2].
To continue talking to Dosu, mention @dosu.
skvrd
r13i
Bug Description
I am trying to fetch Confluence documents using API tokens, and the fetch works fine using the Atlassian Confluence SDK
atlassian-python-api:However, using the same parameters in the
ConfluenceReaderfrom Llama Index mapped behind the scenes to the exact same parameters in the Atlassian SDK:I get
HTTPError: Current user not permitted to use Confluence.Version:
Version
0.10.55
Steps to Reproduce
See description above
Relevant Logs/Tracbacks