{"_id":"5601ab4c6811d00d00ceb482","user":"5600607c3aa0520d00da0b51","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"project":"55faeacad0e22017005b8265","category":{"_id":"5601afd381a9670d006d1652","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":11,"pages":["5602341e930fe1170074bd22","560235191ba3720d00a6b9a4","561d4dec57165b0d00aa5d94","561d4e369e8e1f0d00983286","561d4e669e8e1f0d00983288","561d4ed26386060d00e06011","561d4f3457165b0d00aa5d97","563108d8f1c0580d00fac6f1","5645082598da41190099f31a","5665cf36e93ae70d00b969f8","56abda994e8ba20d006a23f7"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:45:23.406Z","from_sync":false,"order":4,"slug":"authentication-guide","title":"Authentication Guide"},"editedParams":true,"__v":11,"parentDoc":null,"editedParams2":true,"updates":["57965b5cfa1ff60e006a1250"],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T19:26:04.541Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"access_token\": \"<your_token_here>\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 604800,\n    \"refresh_token\": \"<your_refresh_token_here>\",\n    \"scope\": \"read write\"\n}","name":""}]},"settings":"5601b1ee50ee460d00022259","examples":{"codes":[{"language":"python","code":"","name":""}]},"auth":"required","params":[{"_id":"5601d5c77435de0d00fabc2f","ref":"","in":"body","required":true,"desc":"The grant_type is \"password\"","default":"password","type":"string","name":"grant_type"},{"_id":"5601d5c77435de0d00fabc2e","ref":"","in":"body","required":true,"desc":"Your GBDX Username","default":"","type":"string","name":"username"},{"_id":"5601d6427435de0d00fabc31","ref":"","in":"body","required":true,"desc":"Your GBDX Password","default":"","type":"string","name":"password"}],"url":"/auth/v1/oauth/token/"},"isReference":false,"order":4,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Access Credentials\",\n  \"body\": \"You will need your username, password, and API key to get a token. Enter \\\"password\\\" for the grant type, GBDX username, and password. When you select \\\"try\\\" a pop-up box will ask for your API key.\"\n}\n[/block]","excerpt":"How to get an Oauth2 Token if you have an api-key","slug":"get-oauth-token","type":"endpoint","title":"Get OAuth Token (api-key)"}

postGet OAuth Token (api-key)

How to get an Oauth2 Token if you have an api-key

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

grant_type:
required
stringpassword
The grant_type is "password"
username:
required
string
Your GBDX Username
password:
required
string
Your GBDX Password

Result Format


Documentation

[block:callout] { "type": "danger", "title": "Access Credentials", "body": "You will need your username, password, and API key to get a token. Enter \"password\" for the grant type, GBDX username, and password. When you select \"try\" a pop-up box will ask for your API key." } [/block]

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 }}