GetOAuthAccessToken
Obtains the OAuth access token to be used for authentication with Xero.
Input
Name | Type | Required | Description |
AuthMode | String | True | The type of authentication mode to use.
The allowed values are APP, WEB. The default value is WEB. |
AuthToken | String | False | The authentication token returned by GetOAuthAuthorizationUrl. Required for only the Web AuthMode. |
AuthKey | String | False | The AuthKey returned by GetOAuthAuthorizationUrl. Required for only the Web AuthMode. |
CallbackURL | String | False | This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the Developer Portal, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/'). |
Verifier | String | False | The verifier token returned by Xero after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
PKCEVerifier | String | False | The PKCEVerifier returned by GetOAuthAuthorizationURL. |
Result Set Columns
Name | Type | Description |
OAuthAccessToken | String | The authentication token returned from Xero. This can be used in subsequent calls to other operations for this particular service. |
OAuthAccessTokenSecret | String | The authentication token secret returned from Xero. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |