Feedback Edit

OAuthBasedDataSourceProperties Class

  • Reference

The properties that are associated with data sources that use OAuth as their authentication model.

Inheritance
Model
OAuthBasedDataSourceProperties

Constructor

OAuthBasedDataSourceProperties(*, refresh_token: Optional[str] = None, token_user_principal_name: Optional[str] = None, token_user_display_name: Optional[str] = None, **kwargs)

Parameters

refresh_token
str
Required

A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

token_user_principal_name
str
Required

The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

token_user_display_name
str
Required

The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.