{"_id":"5a846848a52194001288900b","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"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"],"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":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-14T16:48:08.209Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"No Output","language":"text","status":201},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        }\n    ]\n}","language":"json","name":"Body Parameter Invalid","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"required properties are missing: scope\"\n        }\n    ]\n}","language":"json","name":"Body Parameter Missing","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/scope\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}","language":"json","name":"Scope Value Invalid","status":400}]},"settings":"","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/meta/Cba51989ee5aa9606bcda1491;userPolicy/policy HTTP/1.1\nauthorization: AUTH_TOKEN\n\n{\n\t\"scope\": \"user\"\n}","language":"http"},{"code":"droplit.keyPolicies.create(\"Cba51989ee5aa9606bcda1491\", { \"scope\" : \"user\" });","language":"javascript","name":"Droplit SDK"}]},"method":"post","auth":"required","params":[{"_id":"5a85d9da6e3c450021e19e81","ref":"","in":"path","required":true,"desc":"The key policy ID follows the format: ecosystemId;keyName","default":"","type":"string","name":"keyPolicyId"},{"_id":"5a85d9da6e3c450021e19e80","ref":"","in":"body","required":true,"desc":"The allowed scopes are \"global\", \"user\", \"application\", and \"app user\".","default":"","type":"string","name":"scope"},{"_id":"5a85d9da6e3c450021e19e7f","ref":"","in":"header","required":true,"desc":"The user's authorization token","default":"","type":"string","name":"authorization"}],"url":"/api/meta/:keyPolicyId/policy"},"isReference":false,"order":1,"body":"","excerpt":"Create a new scoping policy for a metadata key.","slug":"create-key-policy","type":"endpoint","title":"Create Key Policy"}

postCreate Key Policy

Create a new scoping policy for a metadata key.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

scope:
required
string
The allowed scopes are "global", "user", "application", and "app user".

Headers

authorization:
required
string
The user's authorization token

Examples


Result Format


User Information

Try It Out

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