{"_id":"5a96f9da4e32d9005eeb3f1c","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":36,"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","5a96f89c89442e002041144b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"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":6,"slug":"authentication-guide","title":"Authentication Guide"},"user":"55fae9d4825d5f19001fa379","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-28T18:50:02.919Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"username\": \"USER_NAME(this is an email address)\",\n    \"user_id\": \"USER_ID\",\n    \"account_id\": \"ACCOUNT_ID\",\n    \"roles\": [\"ROLE\"],\n    \"id\": \"USER_ID\",\n    \"role\": \"ROLE\",\n    \"is_super_user\": false,\n    \"email\": \"USER_EMAIL\",\n    \"account_level\": \"LEVEL\"\n}"}]},"method":"get","examples":{"codes":[]},"settings":"5601fdaa1ba3720d00a6b981","auth":"required","params":[],"url":"/auth/v1/validate_token"},"isReference":false,"order":4,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"You'll need your GBDX token to try this request\",\n  \"body\": \"When you select the \\\"try it out\\\" button, you'll be prompted to enter your token.\"\n}\n[/block]\n## Response Properties\n\nProperty Name | Value | More information\n--- | ---\nusername | GBDX user name | In most cases, the username is the user's email address. A small set of legacy usernames are not email addresses. \nuser_id | GBDX user ID | This is the identification number associated with the user.\naccount_id | GBDX account ID | this is the identification number for the GBDX account the user is associated with.\nroles | List of roles associated with the user | At this time, users can only have one role. \nid | user ID | This field has the same value as the \"user_id\" field for backward compatibility.\nrole | the role associated with the user | This field has the same value as the \"roles\" field. It has been retained for backward compatibility.\nis_super_user | TRUE/FALSE value | This value is set to false unless the user has been granted \"super user\" permissions by GBDX. \nemail | The email address the user entered when signing up for a GBDX account | For most users, the \"username\" and \"email\" fields will have the same value. \naccount_level | GBDX account level | Examples: Basic, Eval","excerpt":"Validate your token, and get information about your account.\n\n**IMPORTANT**:  The \"Validate Token\" response changed on 3/22/2018. This documentation shows the new response.","slug":"validate-a-token","type":"endpoint","title":"Validate a Token"}

getValidate a Token

Validate your token, and get information about your account. **IMPORTANT**: The "Validate Token" response changed on 3/22/2018. This documentation shows the new response.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

[block:callout] { "type": "info", "title": "You'll need your GBDX token to try this request", "body": "When you select the \"try it out\" button, you'll be prompted to enter your token." } [/block] ## Response Properties Property Name | Value | More information --- | --- username | GBDX user name | In most cases, the username is the user's email address. A small set of legacy usernames are not email addresses. user_id | GBDX user ID | This is the identification number associated with the user. account_id | GBDX account ID | this is the identification number for the GBDX account the user is associated with. roles | List of roles associated with the user | At this time, users can only have one role. id | user ID | This field has the same value as the "user_id" field for backward compatibility. role | the role associated with the user | This field has the same value as the "roles" field. It has been retained for backward compatibility. is_super_user | TRUE/FALSE value | This value is set to false unless the user has been granted "super user" permissions by GBDX. email | The email address the user entered when signing up for a GBDX account | For most users, the "username" and "email" fields will have the same value. account_level | GBDX account level | Examples: Basic, Eval

User Information

Try It Out

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