Help Page Home - OAuth
GET authorisation/token
Request an access token using the password credential grant process. Visit the documentation area on authentication for detailed explanation. Requires that the grant request be performed using a GET request and URL parameters. This is NOT the preferred method and using a POST request is preferred
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
grant_type | The OAuth grant type. For password credential grant, this must be 'password'. | string |
Required |
username | The username. For example, someone@emailhost.com. | string |
Required |
password | The password of the user. | string |
Required |
scope | The scope requested. For example, 'full'. | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ObjectName | Description | Type | Additional information |
---|
Response Formats
application/json, text/json
Sample:
{ "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.DItMjAxNSAwNTowNjoyOS43NDE0NzYiLCJyb2xlIjoiYWNjZXNzIn0", "token_type": "Bearer", "expires_in": 10800, "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MioIn0.4fEXVBxeFQB3YkfSQ-W1Wp5XiZJv2jsivcYR2fP73PQ", "scope": "full fileid:15431 fileid:14078 fileid:2045" }
application/xml, text/xml
Sample:
<OAuthAccessTokenGrant xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <access_token>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.DItMjAxNSAwNTowNjoyOS43NDE0NzYiLCJyb2xlIjoiYWNjZXNzIn0</access_token> <token_type>Bearer</token_type> <expires_in>10800</expires_in> <refresh_token>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MioIn0.4fEXVBxeFQB3YkfSQ-W1Wp5XiZJv2jsivcYR2fP73PQ</refresh_token> <scope>full fileid:15431 fileid:14078 fileid:2045</scope> </OAuthAccessTokenGrant>