CData Python Connector for PingOne

Build 25.0.9454

GetOAuthAccessToken

Gets an authentication token from PingOne.

Input

Name Type Description
AuthMode String 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. If the OAuthClient authentication scheme is being used, WEB will always be used regardless of the value specified here.

The allowed values are APP, WEB.

The default value is APP.

CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the PingOne app settings. Only needed when the AuthMode parameter is WEB. The value used here takes precedence over the value specified in the 'CallbackURL' connection property.

The default value is http://localhost:33333.

State String 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 PingOne authorization server and back. Uses include redirecting the user to the correct resource in your site, nonce-s, and cross-site-request-forgery mitigations.
Verifier String The verifier code returned from PingOne 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 OAuth access token used for communication with PingOne.
OAuthRefreshToken String The OAuth refresh token for generating a new access token and refresh token after the current ones expires.
ExpiresIn Int The remaining lifetime on the access token. A -1 denotes that it will not expire.

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