Cmdlets for SAP HANA XSA

Build 24.0.9060

GetOAuthAccessToken

Gets an authentication token from SAPHanaXSA.

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.

The allowed values are APP, WEB.

The default value is APP.

Scope String False A comma-separated list of permissions to request from the user. Please check the SAPHanaXSA API for a list of available permissions.
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 SAPHanaXSA app settings. Only needed when the Authmode parameter is Web.
Verifier String False The verifier returned from SAPHanaXSA 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.
State String False Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the SAPHanaXSA authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with SAPHanaXSA.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in the case of SAPHanaXSA.
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.9060