{"__v":3,"_id":"55fcb0e851dbf70d00c61b43","category":{"__v":0,"_id":"56394a2f68b11f0d0048c9ff","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:58:39.551Z","from_sync":false,"order":16,"slug":"api-authentication-settings","title":"API: Authentication Settings"},"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-19T00:48:40.870Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Authentication Settings define the, for example, OAuth settings required to successfully make an API Call.\nExample:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n    \\t\\\"access\\\": {\\n        \\\"keys\\\": false, \\n        \\\"org_keys\\\": false, \\n        \\\"org_settings\\\": false, \\n        \\\"settings\\\": false\\n      }, \\n      \\\"keys\\\": {\\n        \\\"client_secret\\\": null, \\n        \\\"client_id\\\": null\\n      }, \\n      \\\"meta\\\": {\\n        \\\"domain\\\": \\\"httpbin.org\\\", \\n        \\\"description\\\": null, \\n        \\\"created\\\": \\\"2015-09-14T23:19:52.888168Z\\\", \\n        \\\"documentation\\\": {\\n          \\\"keys\\\": null, \\n          \\\"docs\\\": null, \\n          \\\"apps\\\": null, \\n          \\\"provider\\\": null\\n        }, \\n        \\\"last_update\\\": \\\"2015-09-14T23:19:52.888175Z\\\", \\n        \\\"owner\\\": \\\"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\\\", \\n        \\\"tags\\\": [], \\n        \\\"name\\\": \\\"Minimal Auth Settings name\\\"\\n      }, \\n      \\\"id\\\": \\\"agxkZXZ-dmlhdGVzdHNyGgsSDVNlcnZpY2VDb25maWcYgICAgKDdjQgM\\\", \\n      \\\"settings\\\": {\\n        \\\"auth_type\\\": \\\"NONE\\\", \\n        \\\"custom_variables\\\": {}\\n      }\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-2\": \"required?\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"meta\",\n    \"0-1\": \"See section below\",\n    \"0-2\": \"Yes\",\n    \"1-0\": \"access\",\n    \"1-1\": \"See section below\",\n    \"1-2\": \"No\",\n    \"2-0\": \"settings\",\n    \"2-1\": \"See section below\",\n    \"2-2\": \"Yes\",\n    \"3-0\": \"keys\",\n    \"3-1\": \"See section below\",\n    \"3-2\": \"No\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\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    \"0-0\": \"name\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"required?\",\n    \"0-2\": \"Yes\",\n    \"0-1\": \"Name for your reference\",\n    \"1-0\": \"tags\",\n    \"1-1\": \"List of tags for your reference\",\n    \"1-2\": \"No\",\n    \"2-0\": \"description\",\n    \"2-1\": \"Description for your reference\",\n    \"2-2\": \"No\",\n    \"3-0\": \"owner\",\n    \"3-2\": \"No - read only\",\n    \"3-1\": \"ID of owner\",\n    \"4-0\": \"domain\",\n    \"4-1\": \"hostname for URLs that use this authentication\",\n    \"4-2\": \"No\",\n    \"5-0\": \"documentation\",\n    \"5-1\": \"See below\",\n    \"5-2\": \"No\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"meta.documentation\"\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\": \"No\",\n    \"1-2\": \"No\",\n    \"2-2\": \"No\",\n    \"3-2\": \"No\",\n    \"0-0\": \"keys\",\n    \"1-0\": \"docs\",\n    \"2-0\": \"apps\",\n    \"3-0\": \"provider\",\n    \"3-1\": \"Link to homepage of site\",\n    \"2-1\": \"Link to developer app creation page for site\",\n    \"1-1\": \"Link to developer docs for site\",\n    \"0-1\": \"Link to developer keys page in site\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"access\"\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\": \"settings\",\n    \"0-2\": \"No\",\n    \"1-0\": \"keys\",\n    \"2-0\": \"org_settings\",\n    \"3-0\": \"org_keys\",\n    \"0-1\": \"Are the settings shared with the APImetrics Community?\",\n    \"1-1\": \"Are the client id and secret shared with the APImetrics Community?\",\n    \"1-2\": \"No\",\n    \"2-1\": \"Are the settings shared with your organization?\",\n    \"3-1\": \"Are the client id and secret shared with your organization?\",\n    \"2-2\": \"No\",\n    \"3-2\": \"No\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"settings\"\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\": \"auth_type\",\n    \"0-1\": \"Kind of authentication, one of:\\n\\\"MANUAL\\\", \\\"BASIC\\\", \\\"OAUTH1\\\", \\\"OAUTH2\\\", \\\"NONE\\\", \\\"OAUTH2_JWS\\\", \\\"OAUTH2_JWT\\\", \\\"AMAZON\\\"\",\n    \"0-2\": \"Yes\",\n    \"1-0\": \"custom_variables\",\n    \"1-1\": \"Dictionary of custom variables for use in API calls\",\n    \"1-2\": \"No\",\n    \"2-0\": \"...\",\n    \"2-1\": \"Other keys may be added depending on the Authentication Type.\",\n    \"2-2\": \"No\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"access\\\": {\\n    \\\"keys\\\": false, \\n    \\\"org_keys\\\": false, \\n    \\\"org_settings\\\": false, \\n    \\\"settings\\\": false\\n  }, \\n  \\\"keys\\\": {\\n    \\\"client_secret\\\": null, \\n    \\\"client_id\\\": null\\n  }, \\n  \\\"meta\\\": {\\n    \\\"domain\\\": \\\"httpbin.org\\\", \\n    \\\"description\\\": null, \\n    \\\"documentation\\\": {\\n      \\\"keys\\\": null, \\n      \\\"docs\\\": null, \\n      \\\"apps\\\": null, \\n      \\\"provider\\\": null\\n    }, \\n    \\\"owner\\\": \\\"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\\\", \\n    \\\"tags\\\": [], \\n    \\\"name\\\": \\\"Auth Settings update\\\"\\n  }, \\n  \\\"settings\\\": {\\n    \\\"auth_type\\\": \\\"OAUTH2_JWT\\\", \\n    \\\"authorize_url\\\": \\\"http://httpbin.org/get\\\", \\n    \\\"custom_variables\\\": {}\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"This describes the format of the JSON object for the /auth calls","slug":"auth-object","type":"basic","title":"Auth Object"}

Auth Object

This describes the format of the JSON object for the /auth calls

Authentication Settings define the, for example, OAuth settings required to successfully make an API Call. Example: [block:code] { "codes": [ { "code": " {\n \t\"access\": {\n \"keys\": false, \n \"org_keys\": false, \n \"org_settings\": false, \n \"settings\": false\n }, \n \"keys\": {\n \"client_secret\": null, \n \"client_id\": null\n }, \n \"meta\": {\n \"domain\": \"httpbin.org\", \n \"description\": null, \n \"created\": \"2015-09-14T23:19:52.888168Z\", \n \"documentation\": {\n \"keys\": null, \n \"docs\": null, \n \"apps\": null, \n \"provider\": null\n }, \n \"last_update\": \"2015-09-14T23:19:52.888175Z\", \n \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n \"tags\": [], \n \"name\": \"Minimal Auth Settings name\"\n }, \n \"id\": \"agxkZXZ-dmlhdGVzdHNyGgsSDVNlcnZpY2VDb25maWcYgICAgKDdjQgM\", \n \"settings\": {\n \"auth_type\": \"NONE\", \n \"custom_variables\": {}\n }\n }", "language": "json" } ] } [/block] [block:parameters] { "data": { "h-2": "required?", "h-0": "Name", "h-1": "Description", "0-0": "meta", "0-1": "See section below", "0-2": "Yes", "1-0": "access", "1-1": "See section below", "1-2": "No", "2-0": "settings", "2-1": "See section below", "2-2": "Yes", "3-0": "keys", "3-1": "See section below", "3-2": "No" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "meta" } [/block] [block:parameters] { "data": { "0-0": "name", "h-0": "Name", "h-1": "Description", "h-2": "required?", "0-2": "Yes", "0-1": "Name for your reference", "1-0": "tags", "1-1": "List of tags for your reference", "1-2": "No", "2-0": "description", "2-1": "Description for your reference", "2-2": "No", "3-0": "owner", "3-2": "No - read only", "3-1": "ID of owner", "4-0": "domain", "4-1": "hostname for URLs that use this authentication", "4-2": "No", "5-0": "documentation", "5-1": "See below", "5-2": "No" }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "meta.documentation" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "required?", "0-2": "No", "1-2": "No", "2-2": "No", "3-2": "No", "0-0": "keys", "1-0": "docs", "2-0": "apps", "3-0": "provider", "3-1": "Link to homepage of site", "2-1": "Link to developer app creation page for site", "1-1": "Link to developer docs for site", "0-1": "Link to developer keys page in site" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "access" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "settings", "0-2": "No", "1-0": "keys", "2-0": "org_settings", "3-0": "org_keys", "0-1": "Are the settings shared with the APImetrics Community?", "1-1": "Are the client id and secret shared with the APImetrics Community?", "1-2": "No", "2-1": "Are the settings shared with your organization?", "3-1": "Are the client id and secret shared with your organization?", "2-2": "No", "3-2": "No" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "settings" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required", "0-0": "auth_type", "0-1": "Kind of authentication, one of:\n\"MANUAL\", \"BASIC\", \"OAUTH1\", \"OAUTH2\", \"NONE\", \"OAUTH2_JWS\", \"OAUTH2_JWT\", \"AMAZON\"", "0-2": "Yes", "1-0": "custom_variables", "1-1": "Dictionary of custom variables for use in API calls", "1-2": "No", "2-0": "...", "2-1": "Other keys may be added depending on the Authentication Type.", "2-2": "No" }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n \"access\": {\n \"keys\": false, \n \"org_keys\": false, \n \"org_settings\": false, \n \"settings\": false\n }, \n \"keys\": {\n \"client_secret\": null, \n \"client_id\": null\n }, \n \"meta\": {\n \"domain\": \"httpbin.org\", \n \"description\": null, \n \"documentation\": {\n \"keys\": null, \n \"docs\": null, \n \"apps\": null, \n \"provider\": null\n }, \n \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n \"tags\": [], \n \"name\": \"Auth Settings update\"\n }, \n \"settings\": {\n \"auth_type\": \"OAUTH2_JWT\", \n \"authorize_url\": \"http://httpbin.org/get\", \n \"custom_variables\": {}\n }\n}", "language": "json" } ] } [/block]