CData Python Connector for Microsoft SharePoint

Build 25.0.9454

GetOAuthAccessToken

Obtains an OAuth access token required for authentication with SharePoint. Necessary for making authenticated API requests.

Input

Name Type Required Description
AuthMode String False Specifies the authentication mode to use. Allowed values: 'APP' for application-based authentication and 'WEB' for user-based authentication.
Verifier String False The verifier token returned by SharePoint after authorization. This is required only when using 'WEB' as the AuthMode and must be obtained from the URL generated by GetOAuthAuthorizationURL.
CallbackUrl String False The URL where the user is redirected after granting authorization. This must match the Reply URL configured in the SharePoint/Azure AD app settings.
Scope String False The permissions requested from the user. Determines the level of access granted to the application.
State String False A custom value that is sent with the callback to maintain session state and prevent cross-site request forgery (CSRF) attacks.
Prompt String False Defines how the authentication prompt is displayed to the user. Defaults to 'select_account'. Options: 'None' (no prompt), 'login' (forces login), and 'consent' (triggers the OAuth consent dialog asking for permission).

Result Set Columns

Name Type Description
OAuthAccessToken String The authentication token returned from SharePoint. This token is required for making API requests on behalf of the authenticated user or application.
OAuthRefreshToken String A refresh token that can be used to obtain a new access token without requiring user interaction.
ExpiresIn String The remaining lifetime of the access token in seconds. A value of -1 indicates that the token does not expire.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454