{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/auth/shortcode/create","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{\n    \"shortcode\": \"A6ER7D\",\n    \"ecosystemId\": \"C58521fd8a5d9b5cc21987501\",\n    \"environmentId\": \"E58262813c008b1a547b01c2a\",\n    \"userId\": \"58a915181cde95612f38b50a;short|A6ER7D\"\n}","name":"With Environment ID"},{"status":201,"language":"json","code":"{\n    \"shortcode\": \"DRYV6A\",\n    \"ecosystemId\": \"C58521fd8a5d9b5cc21987501\",\n    \"userId\": \"C58521fd8a5d9b5cc21987501;auth0|59ad5e8843f89ba26c5b80ca\"\n}","name":"With User ID"},{"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}","language":"json","name":"Invalid Body - either \"environmentId\" or \"userId\" must be present","status":400},{"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}","language":"json","status":400,"name":"No Query String Allowed"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"invalid environment id\",\n            \"path\": \"environmentId\"\n        }\n    ]\n}","language":"json","name":"Invalid Environment ID","status":400},{"code":"Environment with id E58a62813b00ab1954eb01c2e does not exist.","language":"text","name":"Environment ID not found","status":404}]},"settings":"","params":[{"name":"environmentId","type":"string","default":"","desc":"The ID of the environment for which the code grants access.","required":false,"in":"body","ref":"","_id":"5b25df5ea03e480003de6506"},{"name":"userId","type":"string","default":"","desc":"The ID of the user with which the code is associated.","required":false,"in":"body","ref":"","_id":"5b25df5ea03e480003de6505"},{"name":"shortCodeTtl","type":"int","default":"","desc":"The lifetime of the shortcode's validity in seconds.","required":false,"in":"body","ref":"","_id":"5b25df5ea03e480003de6504"},{"name":"tokenExpiryType","type":"string","default":"","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.","required":false,"in":"body","ref":"","_id":"5b25df5ea03e480003de6503"},{"name":"tokenTtl","type":"int","default":"","desc":"The lifetime of the shortcode's token.","required":false,"in":"body","ref":"","_id":"5b25df5ea03e480003de6502"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b291d2694e1f7000317ff47"},{"name":"Content-Type","type":"string","default":"","desc":"Specify that the sent data will be a JSON object.","required":true,"in":"header","ref":"","_id":"5b291d2694e1f7000317ff46"}],"examples":{"codes":[{"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}","language":"http","name":"With Environment ID"},{"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}","language":"http","name":"With User ID"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create Shortcode","type":"endpoint","slug":"consume-shortcode","excerpt":"Generate a shortcode that will be consumed for authentication.","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.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b258267a03e480003de6162","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Authorization API","slug":"authorization-api","order":15,"from_sync":false,"reference":false,"_id":"5b258091bc7a6700033b9cb5","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2018-06-16T21:26:41.906Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-06-16T21:34:31.359Z","githubsync":"","__v":11,"parentDoc":null}

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