{"_id":"59c33ede9aea850010ac4382","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c33affb2b45c0010b7aa23","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-21T04:07:27.858Z","from_sync":false,"order":15,"slug":"users-api","title":"Users API"},"user":"58cc41f21751ce2f003be3b7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T04:23:58.479Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a85b6b02c545000f08a77f","auth":"required","params":[{"_id":"59c33c119aea850010ac42b7","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"ecosystemId"},{"_id":"59c33c119aea850010ac42b6","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"userId"},{"_id":"59c33dff9aea850010ac430b","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"expiryType"},{"_id":"59c33dff9aea850010ac4309","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"ttl"}],"url":"/:ecosystemId;:userId/tokens"},"isReference":false,"order":4,"body":"# Details\n\nGenerate a user token.\n\nThe user ID must be explicitly specified using the ecosystem ID which contains that user.\nThe following token expiration types are valid:\n1. Infinite: A token that never expires.\n2. FixedTtl: A token that expires after a set amount of time (“fixed time to live”).\n3. SlidingTtl: A token that expires after a set amount of time from the last time it was used (“sliding time to live”). Using the token within the allotted time resets the amount of time it is valid.\n\nAn account token or server token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- ecosystemId (required): The ID of the ecosystem.\n- id (required): The unique ID of a user.\n\n## query\n\n- expiryType (optional): The manner in which a generated user token should expire. Default is “FixedTtl.”\n- ttl (optional): The time that a generated user token will be valid, in seconds. Default is 3600.\n\n# Responses\n\n## 200\n\n```\n{\n    \"token\": \"USER-TOKEN\"\n}\n```\n\n## 400\n\n- __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint.\n- __Token Duration Invalid:__ This error means that the token duration given was invalid, and the standard error structure lists this as invalid parameters. Token duration should be listed as a positive number of seconds.\n- __Token Expiration Type Invalid:__ This error means that the type of token expiration type given was invalid, and the standard error structure lists this as invalid parameters.\n- __User Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the ID of the user given was not valid.\n\n## 404\n\n- __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.\n- __User Not Found:__ This error means that user with the given ID was not found.\n\n# Examples\n\n## HTTP\n\n```\nPOST https://ioe.droplit.io/api/users/ECOSYSTEM-ID;USER-ID/tokens HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit user create-token USER-ID\n```","excerpt":"","slug":"users-generate-tokens","type":"endpoint","title":"Generate a user token."}

putGenerate a user token.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ecosystemId:
required
string
userId:
required
string

Query Params

expiryType:
string
ttl:
integer

Documentation

# Details Generate a user token. The user ID must be explicitly specified using the ecosystem ID which contains that user. The following token expiration types are valid: 1. Infinite: A token that never expires. 2. FixedTtl: A token that expires after a set amount of time (“fixed time to live”). 3. SlidingTtl: A token that expires after a set amount of time from the last time it was used (“sliding time to live”). Using the token within the allotted time resets the amount of time it is valid. An account token or server token may be used to run this endpoint. # Parameters ## path - ecosystemId (required): The ID of the ecosystem. - id (required): The unique ID of a user. ## query - expiryType (optional): The manner in which a generated user token should expire. Default is “FixedTtl.” - ttl (optional): The time that a generated user token will be valid, in seconds. Default is 3600. # Responses ## 200 ``` { "token": "USER-TOKEN" } ``` ## 400 - __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint. - __Token Duration Invalid:__ This error means that the token duration given was invalid, and the standard error structure lists this as invalid parameters. Token duration should be listed as a positive number of seconds. - __Token Expiration Type Invalid:__ This error means that the type of token expiration type given was invalid, and the standard error structure lists this as invalid parameters. - __User Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID. In this context, it means that the ID of the user given was not valid. ## 404 - __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does. - __User Not Found:__ This error means that user with the given ID was not found. # Examples ## HTTP ``` POST https://ioe.droplit.io/api/users/ECOSYSTEM-ID;USER-ID/tokens HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit user create-token USER-ID ```

User Information

Try It Out

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