{"_id":"58fd369954decc0f00f6bd4f","category":{"_id":"58fd1460809fc30f00f2ee07","__v":0,"project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-04-23T20:53:52.828Z","from_sync":false,"order":2,"slug":"oauth","title":"OAuth"},"githubsync":"","__v":1,"project":"55c8cff571d7580d0063a5e5","user":"56f99ab84d2b4f3400edb636","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-23T23:19:53.460Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"Authorization Code Grant","code":"{\n    \"access_token\": \"R3dhqHR1BK8iGBM4WkKKPGj2SXYLrxWS41706656~6\",\n    \"token_type\": \"Bearer\",\n    \"scope\": \"account-owner extension-user\",\n    \"refresh_token\": \"2d4IwvmlfsY8cbjDeO7BLrwRPAp2KjQUAIuWvEh8\",\n    \"expires_in\": 3600\n}","language":"json","status":200},{"name":"Client Credential Grant","status":200,"code":"{\n    \"access_token\": \"hTBRLR8jK0augxpQBgJBUNfkSY8XafUn48Jt8V7Q\",\n    \"token_type\": \"Bearer\",\n    \"scope\": \"account-owner\"\n}","language":"json"},{"code":"{\n    \"access_token\": \"acZXD00Ze4EkV7nNlrvoKa1RyIjVqFSs9v706656~6\",\n    \"token_type\": \"Bearer\",\n    \"scope\": \"user\",\n    \"refresh_token\": \"Ejw39rVMDw7pMvfFw1NrD1UkjnBwZQVxlufECb2d\",\n    \"expires_in\": 3600\n}","name":"Password Grant","status":200,"language":"json"},{"status":200,"language":"json","code":"{\n    \"access_token\": \"LUN2GyEqF9N20VBvF3OAyYMJpCKXj3VhKD706656~6\",\n    \"token_type\": \"Bearer\",\n    \"scope\": \"user\",\n    \"refresh_token\": \"ZpICmJlrhABDuW5vkuFfm8gzZi6Bk01jjCCGgrF1\",\n    \"expires_in\": 3600\n}","name":"Refresh Token Grant"},{"status":200,"name":"Query String Request","code":"{\n  \"access_token\": \"63h8Wfnw2WqPv55hy9BlI5VsgfoeoaXawz706656~6\",\n  \"token_type\": \"Bearer\",\n  \"scope\": \"account-owner\",\n  \"refresh_token\": \"hJYZMjrbnfCTurXXy5DI4d7w9vRTPzmR72Y2zYeL\",\n  \"expires_in\": 3600\n}","language":"json"}]},"settings":"","examples":{"codes":[{"language":"php","code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/oauth/access-token\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => \"{\\\"grant_type\\\" : \\\"authorization_code\\\", \\\"client_id\\\" : \\\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\\", \\\"client_secret\\\" : \\\"pkjz6Wum6pjthxQiM8G8o2e3ZJeZC6LBfXY92gEI\\\", \\\"code\\\" : \\\"ZskyngqrXlAYadcg6wuIXSKGuSdN1s5J5y706656~6\\\", \\\"redirect_uri\\\" : \\\"http://localhost\\\"}\",\n    CURLOPT_HTTPHEADER => array(\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n  ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","name":"Authorization Code Grant"},{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/oauth/access-token\",\n    CURLOPT_RETURNTRANSFER => true, \n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => \"{\\\"grant_type\\\" : \\\"client_credentials\\\", \\\"client_id\\\" : \\\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\\", \\\"client_secret\\\" : \\\"pkjz6Wum6pjthxQiM8G8o2e3ZJeZC6LBfXY92gEI\\\", \\\"scope\\\" : \\\"account-owner\\\"}\",\n    CURLOPT_HTTPHEADER => array(\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n    ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) { \n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","name":"Client Credential Grant","language":"php"},{"language":"php","name":"Password Grant","code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/oauth/access-token\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => \"{\\\"grant_type\\\" : \\\"password\\\", \\\"client_id\\\" : \\\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\\", \\\"client_secret\\\" : \\\"pkjz6Wum6pjthxQiM8G8o2e3ZJeZC6LBfXY92gEI\\\", \\\"username\\\" : \\\"wai.yuen:::at:::gmail.com\\\", \\\"password\\\" : \\\"Phonecom\\\"}\",\n    CURLOPT_HTTPHEADER => array(\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n  ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}"},{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/oauth/access-token\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => \"{\\\"grant_type\\\" : \\\"refresh_token\\\", \\\"client_id\\\" : \\\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\\", \\\"client_secret\\\" : \\\"pkjz6Wum6pjthxQiM8G8o2e3ZJeZC6LBfXY92gEI\\\", \\\"refresh_token\\\" : \\\"DNsDajTNAtJuN87aEyt7rwtNdcmvGR3wEM4aSIhM\\\"}\",\n    CURLOPT_HTTPHEADER => array(\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n    ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","language":"php","name":"Refresh Token Grant"},{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n  CURLOPT_URL => \"https://api.phone.com/v4/oauth/access-token?grant_type=authorization_code&client_id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&client_secret=pkjz6Wum6pjthxQiM9G9o2e3ZJeZC6LBfXY92gEI&code=gyde4fkqpgKeTR6puoIonDj2f5eeK8xPoO706656~6&redirect_uri=http%3A%2F%2Flocalhost\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n  CURLOPT_POSTFIELDS => \"\",\n  CURLOPT_HTTPHEADER => array(\n      \"cache-control: no-cache\",\n      \"content-type: application/json\"\n  ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","language":"php","name":"Query String Request"}]},"method":"post","auth":"required","params":[{"_id":"58fd6e2d0c09630f00eb7eed","ref":"","in":"body","required":true,"desc":"authorization_code, client_credentials, password or refresh_token","default":"","type":"string","name":"grant_type"},{"_id":"58fd6e2d0c09630f00eb7eec","ref":"","in":"body","required":true,"desc":"Client ID","default":"","type":"string","name":"client_id"},{"_id":"58fd6e2d0c09630f00eb7eeb","ref":"","in":"body","required":true,"desc":"Client Secret Key","default":"","type":"string","name":"client_secret"},{"_id":"58fd6e2d0c09630f00eb7eea","ref":"","in":"body","required":false,"desc":"Authorization Code created via the /oauth/authorization API","default":"","type":"string","name":"code"},{"_id":"58fd6e2d0c09630f00eb7ee9","ref":"","in":"body","required":false,"desc":"The redirect URI where user enters authentication information","default":"","type":"string","name":"redirect_uri"},{"_id":"58fd298754decc0f00f6bcc8","ref":"","in":"body","required":false,"desc":"account-owner, extension-user and/or methods:ALL, separated by space (%20)","default":"","type":"string","name":"scope"},{"_id":"58fd6e2d0c09630f00eb7ee8","ref":"","in":"body","required":false,"desc":"User name","default":"","type":"string","name":"username"},{"_id":"58fd6e2d0c09630f00eb7ee7","ref":"","in":"body","required":false,"desc":"Password","default":"","type":"string","name":"password"},{"_id":"58fd6e2d0c09630f00eb7ee6","ref":"","in":"body","required":false,"desc":"Refresh token","default":"","type":"string","name":"refresh_token"}],"url":"/oauth/access-token"},"isReference":false,"order":2,"body":"","excerpt":"To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.\n\nFor Authorization Code Grant, the input parameter 'code' is generated via the [Create Authorization API](doc:create-oauth-authorization)\n\nNOTE:  The Create Access Token API now accepts requests in query string format as well as JSON body format.\n\nSee [OAuth](doc:oauth) for more details on how to obtain client id and client secret to create an access token at real time.","slug":"create-oauth-access-token","type":"endpoint","title":"Create Access Token"}

postCreate Access Token

To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant. For Authorization Code Grant, the input parameter 'code' is generated via the [Create Authorization API](doc:create-oauth-authorization) NOTE: The Create Access Token API now accepts requests in query string format as well as JSON body format. See [OAuth](doc:oauth) for more details on how to obtain client id and client secret to create an access token at real time.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

grant_type:
required
string
authorization_code, client_credentials, password or refresh_token
client_id:
required
string
Client ID
client_secret:
required
string
Client Secret Key
code:
string
Authorization Code created via the /oauth/authorization API
redirect_uri:
string
The redirect URI where user enters authentication information
scope:
string
account-owner, extension-user and/or methods:ALL, separated by space (%20)
username:
string
User name
password:
string
Password
refresh_token:
string
Refresh token

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}