Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation of response params #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update documentation of response params #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Get authorization url by specifying list of `intuitlib.enums.Scopes` ::

url = auth_client.get_authorization_url([Scopes.ACCOUNTING])

After user connects to the app, the callback URL has params for `state`, `auth_code` and `realm_id` (`realm_id` for Accounting and Payments scopes only)
After user connects to the app, the callback URL has params for `state`, `code` and `realmId` (`realmId` for Accounting and Payments scopes only)

Step 3: Get Tokens and Expiry details
++++++++++++++++++++++++

The `auth_code` from URL params from Step 2 is used to get bearer tokens. Optionally, `realm_id` is passed to set this property for `auth_client` object. ::
The `code` from URL params from Step 2 is used to get bearer tokens. Optionally, `realmId` is passed to set this property for `auth_client` object. ::

auth_client.get_bearer_token(auth_code, realm_id=realm_id)
auth_client.get_bearer_token(code, realm_id=realmId)

After successful response, `access_token`, `refresh_token`, etc properties of `auth_client` object are set.

Expand Down