{"_id":"57160c8ea9055c0e0015fc12","__v":38,"category":{"_id":"57160c7e893cbe0e002d753a","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T10:46:22.085Z","from_sync":false,"order":8,"slug":"key-access-control","title":"Access Control"},"parentDoc":null,"user":"56d548ba075dfa0b00be98d2","githubsync":"","version":{"_id":"56d54a77075dfa0b00be98d8","__v":13,"project":"56d54a77075dfa0b00be98d5","createdAt":"2016-03-01T07:53:27.479Z","releaseDate":"2016-03-01T07:53:27.479Z","categories":["56d54a78075dfa0b00be98d9","56d6bbf046d19315000f8ea2","56d6bbfc46d19315000f8ea3","570cefd98da5b62b00d57e3c","571491a74007610e00c803ae","5714dcd837b7e00e00de5684","5715ea6ac016190e00f04272","5715f27fc016190e00f0429f","5715f7b9893cbe0e002d74da","5715f8c2c016190e00f042b8","5715fd49a9055c0e0015fbe7","57160c7e893cbe0e002d753a","5716136a893cbe0e002d7552"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"56d54a77075dfa0b00be98d5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T10:46:38.440Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:html]\n{\n  \"html\": \"<h3>GetKey</h3>\"\n}\n[/block]\nWill list parameters on a specified access key.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unique identifier.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"1-4\": \"Name of key\",\n    \"2-0\": \"`serialNumber`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Hex Key ID\",\n    \"2-3\": \"FALSE\",\n    \"3-0\": \"`keyValid`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"time string\",\n    \"3-3\": \"FALSE\",\n    \"4-0\": \"`keyExpire`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"time string\",\n    \"4-3\": \"FALSE\",\n    \"5-0\": \"`isAdmin`\",\n    \"5-1\": \"Bool\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"FALSE\",\n    \"6-0\": \"`companyName`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"N/a\",\n    \"6-3\": \"TRUE\",\n    \"7-0\": \"`email`\",\n    \"7-1\": \"String\",\n    \"7-2\": \"N/A\",\n    \"7-3\": \"TRUE\",\n    \"8-0\": \"`mobile`\",\n    \"8-1\": \"String\",\n    \"8-2\": \"N/A\",\n    \"8-3\": \"TRUE\",\n    \"9-0\": \"`phone`\",\n    \"9-1\": \"String\",\n    \"9-2\": \"N/A\",\n    \"9-3\": \"TRUE\",\n    \"10-0\": \"`note`\",\n    \"10-1\": \"String\",\n    \"10-2\": \"N/A\",\n    \"10-3\": \"TRUE\",\n    \"11-0\": \"`expirationDate`\",\n    \"11-1\": \"DateTime\",\n    \"11-2\": \"UTC\",\n    \"11-3\": \"TRUE\",\n    \"12-0\": \"`employeeNumber`\",\n    \"12-1\": \"String\",\n    \"12-2\": \"N/A\",\n    \"12-3\": \"TRUE\",\n    \"13-0\": \"`units`\",\n    \"13-1\": \"String[]\",\n    \"13-2\": \"N/A\",\n    \"13-3\": \"TRUE\",\n    \"14-0\": \"`groups`\",\n    \"14-1\": \"String[]\",\n    \"14-2\": \"N/A\",\n    \"14-3\": \"TRUE\"\n  },\n  \"cols\": 5,\n  \"rows\": 15\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"11456\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"list\\\": [\\n    {\\n      \\\"id\\\": \\\"11456\\\",\\n      \\\"name\\\": \\\"Tom Persson\\\",\\n      \\\"serialNumber\\\": \\\"6200011587691E09\\\",\\n      \\\"keyValid\\\": \\\"60sec\\\",\\n      \\\"keyExpire\\\": \\\"10min\\\",\\n      \\\"isAdmin\\\": false,\\n      \\\"companyName\\\": \\\"Chemnitz Bau- & Materiel\\\",\\n      \\\"note\\\": \\\"\\\",\\n      \\\"expirationDate\\\": \\\"2014-06-30T22:00:00.0000000\\\",\\n      \\\"employeeNumber\\\": \\\"8\\\",\\n      \\\"units\\\": [],\\n      \\\"groups\\\": [\\n        \\\"8820\\\"\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>CreateKey</h3>\"\n}\n[/block]\nWill create a new key.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Name of key\",\n    \"1-0\": \"`serialNumber` <span style=\\\"color:red\\\">*</span>\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Hex Key ID\",\n    \"2-0\": \"`keyValid`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Time string\",\n    \"2-3\": \"Select between the following string values: `30sec` `60sec` `90sec`\",\n    \"3-0\": \"`keyExpire`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Time string\",\n    \"3-3\": \"Select between the following string values: `0sec` `15sec` `30sec` `60sec` `2min` `5min` `10min` `15min` `30min` `1hour` `2hours` `4hours` `8hours` `16hours`\",\n    \"4-0\": \"`isAdmin`\",\n    \"4-1\": \"Bool\",\n    \"4-2\": \"N/A\",\n    \"5-0\": \"`companyName`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"N/A\",\n    \"6-0\": \"`email`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"N/A\",\n    \"7-0\": \"`mobile`\",\n    \"7-1\": \"String\",\n    \"7-2\": \"N/A\",\n    \"8-0\": \"`phone`\",\n    \"8-1\": \"String\",\n    \"8-2\": \"N/A\",\n    \"9-0\": \"`note`\",\n    \"9-1\": \"String\",\n    \"9-2\": \"N/A\",\n    \"10-0\": \"`expirationDate`\",\n    \"10-1\": \"DateTime\",\n    \"10-2\": \"UTC\",\n    \"11-0\": \"`employeeNumber`\",\n    \"11-1\": \"String\",\n    \"11-2\": \"N/A\",\n    \"12-0\": \"`units`\",\n    \"12-1\": \"String[]\",\n    \"12-2\": \"N/A\",\n    \"13-0\": \"`groups`\",\n    \"13-1\": \"String[]\",\n    \"13-2\": \"N/A\"\n  },\n  \"cols\": 4,\n  \"rows\": 14\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"Anton Malmlund\\\",\\n  \\\"serialNumber\\\": \\\"6800801587691F09\\\",\\n  \\\"keyValid\\\": \\\"60sec\\\",\\n  \\\"keyExpire\\\": \\\"10min\\\",\\n  \\\"companyName\\\": \\\"Chemnitz Bau- & Materiel\\\",\\n  \\\"employeeNumber\\\": \\\"21\\\",\\n  \\\"groups\\\": [\\n    \\\"8818\\\"\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"11504\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>UpdateKey</h3>\"\n}\n[/block]\nWill update parameters on an existing key.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Name of key.\",\n    \"2-0\": \"`serialNumber`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Hex Key ID\",\n    \"3-0\": \"`keyValid`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Time string\",\n    \"3-3\": \"Select between the following string values: `30sec` `60sec` `90sec`\",\n    \"4-0\": \"`keyExpire`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Time string\",\n    \"4-3\": \"Select between the following string values: `0sec` `15sec` `30sec` `60sec` `2min` `5min` `10min` `15min` `30min` `1hour` `2hours` `4hours` `8hours` `16hours`\",\n    \"5-0\": \"`isAdmin`\",\n    \"5-1\": \"Bool\",\n    \"5-2\": \"N/A\",\n    \"6-0\": \"`companyName`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"N/A\",\n    \"7-0\": \"`email`\",\n    \"7-1\": \"String\",\n    \"7-2\": \"N/A\",\n    \"8-0\": \"`mobile`\",\n    \"8-1\": \"String\",\n    \"8-2\": \"N/A\",\n    \"9-0\": \"`phone`\",\n    \"9-1\": \"String\",\n    \"9-2\": \"N/A\",\n    \"10-0\": \"`note`\",\n    \"10-1\": \"String\",\n    \"10-2\": \"N/A\",\n    \"11-0\": \"`expirationDate`\",\n    \"11-1\": \"DateTime\",\n    \"11-2\": \"UTC\",\n    \"12-0\": \"`employeeNumber`\",\n    \"12-1\": \"String\",\n    \"12-2\": \"N/A\",\n    \"13-0\": \"`addUnits`\",\n    \"13-1\": \"String[]\",\n    \"13-2\": \"N/A\",\n    \"14-0\": \"`removeUnits`\",\n    \"14-1\": \"String[]\",\n    \"14-2\": \"N/A\",\n    \"15-0\": \"`addGroups`\",\n    \"15-1\": \"String[]\",\n    \"15-2\": \"N/A\",\n    \"16-0\": \"`removeGroups`\",\n    \"16-1\": \"String[]\",\n    \"16-2\": \"N/A\"\n  },\n  \"cols\": 4,\n  \"rows\": 17\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"11455\\\",\\n  \\\"name\\\": \\\"John Ericsson\\\",\\n  \\\"serialNumber\\\": \\\"6100001587691E09\\\",\\n  \\\"addGroups\\\": [\\n    \\\"8818\\\"\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>DeleteKey</h3>\"\n}\n[/block]\nWill delete an existing key.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"11455\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"A **Key** is typically a piece of hardware which serves to identify a person operating a unit, and, if necessary, restricts this person from using specific units. \nA Key is identified by a unique ID, a name, and various contact details.\n\nURL Structure is:\n`https://api.trackunit.com/public/Key`","slug":"key","type":"basic","title":"Key"}