{"_id":"55fca80e3734100d00a9880b","parentDoc":null,"project":"5553d36165e8260d0024419a","category":{"_id":"56394a2f68b11f0d0048c9ff","__v":0,"project":"5553d36165e8260d0024419a","pages":[],"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"},"__v":0,"user":"5553d33065e8260d00244199","version":{"_id":"55fc9b793c21291900e7e0d7","__v":12,"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"},"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T00:10:54.941Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"{\n    \"meta\": {\n        \"name\": \"Auth Settings update\",\n        \"domain\": \"httpbin.org\"\n    },\n    \"settings\": {\n        \"auth_type\": \"OAUTH2_JWT\",\n        \"custom_variables\": {\n            \"foo\": \"bar\",\n            \"api\": 1,\n            \"access_token\": \"asfasdfasdfasdfasdfa\"\n        },\n        \"authorize_url\": \"http://httpbin.org/get\"\n    }\n}\n","language":"json"}]},"method":"put","results":{"codes":[{"name":"","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    \"created\": \"2015-09-18T23:29:43.632611Z\", \n    \"documentation\": {\n      \"keys\": null, \n      \"docs\": null, \n      \"apps\": null, \n      \"provider\": null\n    }, \n    \"last_update\": \"2015-09-18T23:29:43.632626Z\", \n    \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n    \"tags\": [], \n    \"name\": \"Minimal Auth Settings name\"\n  }, \n  \"id\": \"agxkZXZ-dmlhdGVzdHNyGgsSDVNlcnZpY2VDb25maWcYgICAgKDLmgsM\", \n  \"settings\": {\n    \"auth_type\": \"NONE\", \n    \"custom_variables\": {}\n  }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{\n  \"error_msg\": \"meta: 'domain' is a required property\", \n  \"error\": 400\n}"}]},"auth":"required","params":[{"_id":"55fca80e3734100d00a9880c","ref":"","in":"path","required":true,"desc":"ID string of authentication string you're updating","default":"","type":"string","name":"id"}],"url":"/auth/:id/"},"isReference":false,"order":4,"body":"Use this API to create a new Workflow in your account. The JSON schema for the input is available at ./schema.json\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import APImetrics\\n\\nobj_id = \\\"ID_OF_OBJECT\\\"\\n\\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\\\"your_api_key\\\")\\nwith open('update.json') as handle:\\n  data = json.loads(handle.read())\\n  resp = apimetrics.update_auth(obj_id, data)\\n  print result['id']\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","excerpt":"Use this API to update an Authentication Setting.","slug":"auth-2","type":"endpoint","title":"Update an existing Authentication Setting"}

putUpdate an existing Authentication Setting

Use this API to update an Authentication Setting.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
ID string of authentication string you're updating

Examples


Result Format


Documentation

Use this API to create a new Workflow in your account. The JSON schema for the input is available at ./schema.json [block:code] { "codes": [ { "code": "import APImetrics\n\nobj_id = \"ID_OF_OBJECT\"\n\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\"your_api_key\")\nwith open('update.json') as handle:\n data = json.loads(handle.read())\n resp = apimetrics.update_auth(obj_id, data)\n print result['id']", "language": "python" } ] } [/block]

User Information

Try It Out

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