Multiple tenants

Hi there, thanks for making it easier to connect with xero!

I am trying to understand how to leverage xero-python to access multiple organizations.

Let's consider that I have 2 users, who are trying to access different organizations/tenants.

Now all the examples I saw cover using a flask session to store the token. But that solution won't work in a celery task or background job.

I was checking the node client, and it makes super easy to set the token:

import { XeroClient } from 'xero-node';

const xero = new XeroClient({
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
  redirectUris: [`http://localhost/:${port}/callback`],
  scopes: 'openid profile email accounting.transactions offline_access'.split(" ")
});

await xero.initialize();

const tokenSet = getTokenSetFromDatabase(userId); // example function name

await xero.setTokenSet(tokenSet); // Set the token inside the xero client

if(tokenSet.expired()){
  const validTokenSet = await xero.refreshToken();
  // save the new tokenset
}

while with the python client you are forced to use obtain_xero_oauth2_token and store_xero_oauth2_token as a sort of global cache:

# configure token persistence and exchange point between app session and xero-python
@api_client.oauth2_token_getter
def obtain_xero_oauth2_token():
    return session.get("token")

@api_client.oauth2_token_saver
def store_xero_oauth2_token(token):
    session["token"] = token
    session.modified = True

# get existing token set
token_set = get_token_set_from_database(user_id); // example function name

# set token set to the api client
store_xero_oauth2_token(token_set)

# refresh token set on the api client
api_client.refresh_oauth2_token()

any idea on how to avoid this?

@barrachri

Hi @barrachri I'm not familiar with celery but if you can share a hello world project that I can run locally, I'll give it a go. We use the session to store the token in our sample apps for the sake of simplicity but it's not required. You just need to configure the exchange point using the decorators to get and set the token on the api client, but you could be getting/saving the token from/to a db instead

@RettBehrens

Hi @RettBehrens, thanks for your answer.

how would you implement something like this?

# Get invoices for different customers (different tenants)

api_client = ApiClient(
    Configuration(
        debug=app.config["DEBUG"],
        oauth2_token=OAuth2Token(
            client_id=app.config["CLIENT_ID"], client_secret=app.config["CLIENT_SECRET"]
        ),
    ),
    pool_threads=1,
)

# different tenants, with different access token
tenants = [xero_tenant_id_1, xero_tenant_id_2]
invoices = []
  
accounting_api = AccountingApi(api_client)
for tenant in tenants:
    invoices.append(accounting_api.get_invoices(tenant))

From what I understood the only way is this one

api_client = ApiClient(
    Configuration(
        debug=app.config["DEBUG"],
        oauth2_token=OAuth2Token(
            client_id=app.config["CLIENT_ID"], client_secret=app.config["CLIENT_SECRET"]
        ),
    ),
    pool_threads=1,
)

CURRENT_TOKEN = None

@api_client.oauth2_token_getter
def obtain_xero_oauth2_token():
    global CURRENT_TOKEN
    return CURRENT_TOKEN

@api_client.oauth2_token_saver
def store_xero_oauth2_token(token):
    CURRENT_TOKEN = token

# different tenants, with different access token
tenants = [xero_tenant_id_1, xero_tenant_id_2]
invoices = []
  
accounting_api = AccountingApi(api_client)
for tenant in tenants:
    token_set = get_token_from_somewhere()
    store_xero_oauth2_token(token_set)
    invoices.append(accounting_api.get_invoices(tenant))

If that's the only way, I think it would be nice to add a set_token like the js.

api_client = ApiClient(
    Configuration(
        debug=app.config["DEBUG"],
        oauth2_token=OAuth2Token(
            client_id=app.config["CLIENT_ID"], client_secret=app.config["CLIENT_SECRET"]
        ),
    ),
    pool_threads=1,
)

# different tenants, with different access token
tenants = [xero_tenant_id_1, xero_tenant_id_2]
invoices = []
  
accounting_api = AccountingApi(api_client)
for tenant in tenants:
    token_set = get_token_from_somewhere()
    api_client.set_token(token_set)
    invoices.append(accounting_api.get_invoices(tenant))

@barrachri

Hey @barrachri an update on this. Your understanding was correct - currently you'd have to set the token as a global.

Currently the team is focused on squashing bugs and keeping parity with the public API. Since this is more of a feature/enhancement request, it's going to be on the back burner, however, if you want to submit a PR implementing the feature, we'd be happy to review and merge and arrange some Xero swag for your contribution 🙂

You've probably solved this by now but the ApiClient constructor allows you to pass in functions for token get/set like this:

api_client = ApiClient(
    Configuration(
        debug=app.config["DEBUG"],
        oauth2_token=OAuth2Token(
            client_id=app.config["CLIENT_ID"], client_secret=app.config["CLIENT_SECRET"]
        ),
    ),
    oauth2_token_saver=update_token,
    oauth2_token_getter=fetch_token,
    pool_threads=1,
)

In these you can store/retrieve the token any way you like.

@joe-niland

Thanks @joe-niland!

@joe-niland

@joe-niland this is what we have done to handle this the past couple years. Confirming for others. :)

@rdemarco-xero

@rdemarco-xero I think this issue can be closed

Navigation Menu

Repository navigation

Multiple tenants #94

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Multiple tenants #94

Description

Activity

RettBehrens commented on Aug 16, 2022

barrachri commented on Aug 17, 2022

RettBehrens commented on Sep 28, 2022

joe-niland commented on Jan 20, 2023

barrachri commented on Jan 20, 2023

jaredthecoder commented on Apr 26, 2023

joe-niland commented on Apr 26, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions