GetOAuthAccessToken
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Microsoft Planner.
Input
| Name | Type | Required | Description |
| AuthMode | String | False | Specifies the authentication mode to use for obtaining the access token. Use 'App' for scenarios involving desktop applications and 'Web' for web-based applications, ensuring proper alignment with the application type.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | False | Defines a space-separated list of permissions the application is requesting from the user. For 'OAuthGrantType=CODE', the default scope includes 'offline_access https://graph.microsoft.com/User.ReadBasic.All', granting basic user profile access and offline refresh capabilities. For 'OAuthGrantType=CLIENT', the scope defaults to 'https://graph.microsoft.com/.default', leveraging permissions already configured for the app in Azure AD. |
| CallbackUrl | String | False | The URL where the user will be redirected after authorizing the application. This must exactly match the 'Reply URL' configured in the Azure AD application settings to ensure a successful authentication process. |
| Verifier | String | False | The unique verifier string issued by Azure AD after the user authorizes the application. This value is returned as a parameter to the callback URL and is essential for completing the authentication workflow. |
| State | String | False | An optional arbitrary string provided by the app to maintain state between the request and callback. A successful roundtrip of this string confirms that the authentication process was initiated by your application. |
| Prompt | String | False | Controls the user interaction during authentication. Default is 'select_account', prompting the user to choose an account. Other options include 'None' for silent authentication, 'login' to force credential input, or 'consent' to display the permissions consent dialog. |
Result Set Columns
| Name | Type | Description |
| OAuthAccessToken | String | The access token issued by Azure AD, used for authenticated communication with Office 365 APIs. This token is required to perform authorized actions on behalf of the user. |
| ExpiresIn | String | The duration, in seconds, for which the access token remains valid. A value of -1 indicates that the token does not expire, although such cases are uncommon and depend on Azure AD configuration. |
| OAuthRefreshToken | String | The refresh token provided by Azure AD, allowing the application to obtain a new access token without requiring user interaction. This token is essential for maintaining long-lived sessions. |