{"_id":"5b258267a03e480003de6162","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":"5b258091bc7a6700033b9cb5","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-06-16T21:26:41.906Z","from_sync":false,"order":15,"slug":"authorization-api","title":"Authorization API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-16T21:34:31.359Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"With Environment ID","code":"{\n    \"shortcode\": \"A6ER7D\",\n    \"ecosystemId\": \"C58521fd8a5d9b5cc21987501\",\n    \"environmentId\": \"E58262813c008b1a547b01c2a\",\n    \"userId\": \"58a915181cde95612f38b50a;short|A6ER7D\"\n}","language":"json","status":201},{"name":"With User ID","code":"{\n    \"shortcode\": \"DRYV6A\",\n    \"ecosystemId\": \"C58521fd8a5d9b5cc21987501\",\n    \"userId\": \"C58521fd8a5d9b5cc21987501;auth0|59ad5e8843f89ba26c5b80ca\"\n}","language":"json","status":201},{"status":400,"name":"Invalid Body - either \"environmentId\" or \"userId\" must be present","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"id\",\n            \"message\": \"Shortcode must be generated from either an environmentId or userId.\"\n        }\n    ]\n}"},{"name":"No Query String Allowed","status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"contains fields that are not allowed: [ query ]\",\n            \"path\": \"additional parameters\"\n        }\n    ]\n}"},{"status":400,"name":"Invalid Environment ID","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"invalid environment id\",\n            \"path\": \"environmentId\"\n        }\n    ]\n}"},{"status":404,"name":"Environment ID not found","language":"text","code":"Environment with id E58a62813b00ab1954eb01c2e does not exist."}]},"settings":"","examples":{"codes":[{"name":"With Environment ID","language":"http","code":"POST https://ioe.droplit.io/api/auth/shortcode/create HTTP/1.1\nauthorization: AUTH_TOKEN\nContent-Type: application/json\n\n{\n\t\"environmentId\" : \"E58262813c008b1a547b01c2a\",\n\t\"shortCodeTtl\" : 20,\n\t\"tokenExpiryType\" : \"SlidingTtl\",\n\t\"tokenTtl\" : 30\n}"},{"name":"With User ID","language":"http","code":"POST https://ioe.droplit.io/api/auth/shortcode/create HTTP/1.1\nauthorization: AUTH_TOKEN\nContent-Type: application/json\n{\n\t\"userId\" : \"C58521fd8a5d9b5cc21987501;auth0|59ad5e8843f89ba26c5b80ca\",\n\t\"shortCodeTtl\" : 20,\n\t\"tokenExpiryType\" : \"SlidingTtl\",\n\t\"tokenTtl\" : 30\n}"}]},"method":"post","auth":"required","params":[{"_id":"5b25df5ea03e480003de6506","ref":"","in":"body","required":false,"desc":"The ID of the environment for which the code grants access.","default":"","type":"string","name":"environmentId"},{"_id":"5b25df5ea03e480003de6505","ref":"","in":"body","required":false,"desc":"The ID of the user with which the code is associated.","default":"","type":"string","name":"userId"},{"_id":"5b25df5ea03e480003de6504","ref":"","in":"body","required":false,"desc":"The lifetime of the shortcode's validity in seconds.","default":"","type":"int","name":"shortCodeTtl"},{"_id":"5b25df5ea03e480003de6503","ref":"","in":"body","required":false,"desc":"The expiration type of the shortcode token. The type can be either \"Infinite\", where the token never expires, \"FixedTtl\", where the assigned TTL is constant, or \"SlidingTtl\", where the TTL is reset after each time the shortcode's token is used.","default":"","type":"string","name":"tokenExpiryType"},{"_id":"5b25df5ea03e480003de6502","ref":"","in":"body","required":false,"desc":"The lifetime of the shortcode's token.","default":"","type":"int","name":"tokenTtl"},{"_id":"5b291d2694e1f7000317ff47","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5b291d2694e1f7000317ff46","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object.","default":"","type":"string","name":"Content-Type"}],"url":"/api/auth/shortcode/create"},"isReference":false,"order":0,"body":"Create a shortcode in order to authenticate a device for use by a user or within an environment. Either an environment ID OR a user ID must be included in the body of the request.","excerpt":"Generate a shortcode that will be consumed for authentication.","slug":"consume-shortcode","type":"endpoint","title":"Create Shortcode"}

postCreate Shortcode

Generate a shortcode that will be consumed for authentication.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

environmentId:
string
The ID of the environment for which the code grants access.
userId:
string
The ID of the user with which the code is associated.
shortCodeTtl:
integer
The lifetime of the shortcode's validity in seconds.
tokenExpiryType:
string
The expiration type of the shortcode token. The type can be either "Infinite", where the token never expires, "FixedTtl", where the assigned TTL is constant, or "SlidingTtl", where the TTL is reset after each time the shortcode's token is used.
tokenTtl:
integer
The lifetime of the shortcode's token.

Headers

authorization:
required
string
The user's authorization token.
Content-Type:
required
string
Specify that the sent data will be a JSON object.

Examples


Result Format


Documentation

Create a shortcode in order to authenticate a device for use by a user or within an environment. Either an environment ID OR a user ID must be included in the body of the request.

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