GetOAuthAccessToken
Gets an authentication token from ZohoProjects.
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.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the ZohoProjects API for a list of available permissions.
デフォルト値はZohoProjects.portals.ALL,ZohoProjects.projects.ALL,ZohoProjects.status.ALL,ZohoProjects.milestones.ALL,ZohoProjects.tasklists.ALL,ZohoProjects.tasks.ALL,ZohoProjects.tags.ALL,ZohoProjects.bugs.ALL,ZohoProjects.events.ALL,ZohoProjects.forums.ALL,ZohoProjects.users.ALL,ZohoProjects.clients.ALL,ZohoProjects.documents.ALL,ZohoProjects.search.READ,ZohoProjects.entity_properties.ALL,ZohoProjects.activities.READ,ZohoProjects.timesheets.ALLです。 |
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 ZohoProjects app settings. Only needed when the Authmode parameter is Web. |
Verifier | String | False | The verifier returned from ZohoProjects 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 ZohoProjects authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
AccountsServer | String | False | The full Account Server URL that will be used to retrieve the OAuth Access Token. |
Result Set Columns
Name | Type | Description |
OAuthAccessToken | String | The access token used for communication with ZohoProjects. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
AccountsServer | String | The full Account Server URL. |
APIDomain | String | The full URL of the API domain. |