{"_id":"5a846860b5ec3a00120351e8","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":33,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"5a846645b5ec3a001203517e","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-02-14T16:39:33.145Z","from_sync":false,"order":22,"slug":"key-policies","title":"Key Policies"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":7,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-14T16:48:32.697Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n\t\"id\": \"Cba51989ee5aa9606bcda1491;globalPolicy\",\n  \"ecosystemId\": \"Cba51989ee5aa9606bcda1491\",\n  \"keyName\": \"globalPolicy\",\n  \"scope\": \"global\",\n  \"createdAt\": \"2018-02-15T19:45:31.304Z\"\n}","language":"json","status":200},{"name":"Key Policy Invalid","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"string 'C51438aaa4cc2f8181b77f12;testKey' does not match pattern '/^(?:C[a-f0-9]{24}|[a-z0-9-]{1,24});.{1,50}$/'\"\n        }\n    ]\n}","language":"json","status":400},{"code":"Key Policy with id C592347aebca2fb782a7a5191;DNE does not exist.","language":"text","name":"Key Policy Not Found","status":404}]},"settings":"","examples":{"codes":[{"code":"GET https://dev-ioe.droplit.io/api/meta/Cba51989ee5aa9606bcda1491;globalPolicy/policy HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"},{"code":"droplit.keyPolicies.read(\"Cba51989ee5aa9606bcda1491;globalPolicy\");","language":"javascript","name":"Droplit SDK"}]},"method":"get","auth":"required","params":[{"_id":"5a85e3dfa1891b0022a5b36c","ref":"","in":"path","required":true,"desc":"The ID of the key policy: ecosystemId;keyName","default":"","type":"string","name":"keyPolicyId"},{"_id":"5a85e3dfa1891b0022a5b36b","ref":"","in":"header","required":true,"desc":"The user's authorization token","default":"","type":"string","name":"authorization"}],"url":"/meta/:keyPolicyId/policy"},"isReference":false,"order":2,"body":"","excerpt":"Get information regarding a specific key policy.","slug":"read-key-policy","type":"endpoint","title":"Read Key Policy"}

getRead Key Policy

Get information regarding a specific key policy.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

keyPolicyId:
required
string
The ID of the key policy: ecosystemId;keyName

Headers

authorization:
required
string
The user's authorization token

Examples


Result Format


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