Cmdlets for Sage Business Cloud Accounting

Build 24.0.9062

GetOAuthAccessToken

Gets an authentication token from sagebca.

Input

Name Type Required Description
AuthMode String False The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

使用できる値は次のとおりです。APP, WEB

デフォルト値はWEBです。

Scope String False The scope or permissions you are requesting.
CallbackUrl String False The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Sage app settings. Only needed when the Authmode parameter is Web.
State String False An arbitrary string of your choosing that is returned to your app; a successful roundtrip of this string helps ensure that your app initiated the request.
Verifier String False The verifier returned from SageBusinessCloudAccounting after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with sagebca.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in the case of sagebca.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062