{"__v":3,"_id":"55fcb6e956d6990d00a6ca2a","category":{"__v":0,"_id":"56394a5b049e420d00476b5c","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:59:23.891Z","from_sync":false,"order":17,"slug":"api-authentication-tokens","title":"API: Authentication Tokens"},"parentDoc":null,"project":"5553d36165e8260d0024419a","user":"5553d33065e8260d00244199","version":{"__v":12,"_id":"55fc9b793c21291900e7e0d7","project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T01:14:17.719Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Some Authentication schemes generate a token. This object stores that information. An Authentication Setting can have many Tokens.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-0\": \"meta\",\n    \"0-1\": \"See below\",\n    \"0-2\": \"Y\",\n    \"1-0\": \"token\",\n    \"1-1\": \"See below\",\n    \"1-2\": \"N\",\n    \"2-0\": \"api_response\",\n    \"2-1\": \"Object containing the response of the API call that created this token (for JSON APIs)\",\n    \"2-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"meta\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-0\": \"name\",\n    \"0-1\": \"Name of token, for your reference.\",\n    \"0-2\": \"Y\",\n    \"1-0\": \"owner\",\n    \"1-1\": \"ID of the owner\",\n    \"1-2\": \"N - read only\",\n    \"2-0\": \"domain\",\n    \"2-2\": \"N - read only\",\n    \"2-1\": \"Hostname of the site for the authentication (e.g. client.apimetrics.com)\",\n    \"3-0\": \"auth_id\",\n    \"3-1\": \"ID for the authentication settings\",\n    \"3-2\": \"Y\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"token\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"N\",\n    \"0-1\": \"Time the token expires\",\n    \"0-0\": \"expire_time\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","excerpt":"JSON object that describes an authentication Token","slug":"tokens-object","type":"basic","title":"Token Object"}

Token Object

JSON object that describes an authentication Token

Some Authentication schemes generate a token. This object stores that information. An Authentication Setting can have many Tokens. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "meta", "0-1": "See below", "0-2": "Y", "1-0": "token", "1-1": "See below", "1-2": "N", "2-0": "api_response", "2-1": "Object containing the response of the API call that created this token (for JSON APIs)", "2-2": "N" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "meta" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "name", "0-1": "Name of token, for your reference.", "0-2": "Y", "1-0": "owner", "1-1": "ID of the owner", "1-2": "N - read only", "2-0": "domain", "2-2": "N - read only", "2-1": "Hostname of the site for the authentication (e.g. client.apimetrics.com)", "3-0": "auth_id", "3-1": "ID for the authentication settings", "3-2": "Y" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "token" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "N", "0-1": "Time the token expires", "0-0": "expire_time" }, "cols": 3, "rows": 1 } [/block]