{"_id":"59e5941a85e644001a7774df","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":"59cffdef0cd4dd0010294d54","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-30T20:26:23.487Z","from_sync":false,"order":2,"slug":"platform-overview","title":"Platform Overview"},"user":"568bdbc4fe6fcc0d006dc970","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-17T05:24:42.554Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nThe droplit.io Users API provides a way to register your application’s end-users. Your end-users can then make API calls directly to droplit.io.\n\nThe Users API does **not** provide user credential management and is **not** an identity provider. Currently, you the developer must deploy your own authentication server with the only requirement that it authenticate and register your end-users to the Users API. This usually requires integrating or developing an identity provider. Your server must register your end-users by providing the Users API with a key or token that uniquely identifies a user.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"In the future we will provide an option to use third party identity providers for server-less products\",\n  \"title\": \"Future server-less operation\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User access\"\n}\n[/block]\nUsers can currently have only **All or Nothing** access to _environments_. This means that if a user is granted access to an environment, that user can make requests directly to environment and child resource endpoints. This includes API access to:\n\n* Environments\n* Devices\n* Zones \n* Service Classes (Read Only)\n* Account\n\nFor more information see: [Create/Update](doc:create-update-users)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Calling the Users API from your application\"\n}\n[/block]\nYour application can register a user, update user information and access, and create a `userToken` all from a single endpoint. This allows your sever application to not have knowledge of an existing user.\n\n\n## Registering a user\nYour server registers a user by providing a unique id (key or token) that identifies a user. This id is usually provided by your identity provider once a user is sucessfully authenticated.\n\nIn the same request, you can specify:\n\n* account metadata\n* environment access\n* if a user token should be generated\n* user email address (for your identification only)\n\n\n## Logging in a user\n\nA user is logged in when you generate a token.\n\nSee [Account](doc:account) for logging off a user.\n\n## Updating user information or user access\n\nYou can update user information and user access by providing a unique id for a user that is already registered and do not specify to create a token. \n\nFor more information see: [Create/Update](doc:create-update-users)","excerpt":"Your application’s end-users","slug":"users","type":"basic","title":"Users"}

Users

Your application’s end-users

[block:api-header] { "type": "basic", "title": "Introduction" } [/block] The droplit.io Users API provides a way to register your application’s end-users. Your end-users can then make API calls directly to droplit.io. The Users API does **not** provide user credential management and is **not** an identity provider. Currently, you the developer must deploy your own authentication server with the only requirement that it authenticate and register your end-users to the Users API. This usually requires integrating or developing an identity provider. Your server must register your end-users by providing the Users API with a key or token that uniquely identifies a user. [block:callout] { "type": "info", "body": "In the future we will provide an option to use third party identity providers for server-less products", "title": "Future server-less operation" } [/block] [block:api-header] { "type": "basic", "title": "User access" } [/block] Users can currently have only **All or Nothing** access to _environments_. This means that if a user is granted access to an environment, that user can make requests directly to environment and child resource endpoints. This includes API access to: * Environments * Devices * Zones * Service Classes (Read Only) * Account For more information see: [Create/Update](doc:create-update-users) [block:api-header] { "type": "basic", "title": "Calling the Users API from your application" } [/block] Your application can register a user, update user information and access, and create a `userToken` all from a single endpoint. This allows your sever application to not have knowledge of an existing user. ## Registering a user Your server registers a user by providing a unique id (key or token) that identifies a user. This id is usually provided by your identity provider once a user is sucessfully authenticated. In the same request, you can specify: * account metadata * environment access * if a user token should be generated * user email address (for your identification only) ## Logging in a user A user is logged in when you generate a token. See [Account](doc:account) for logging off a user. ## Updating user information or user access You can update user information and user access by providing a unique id for a user that is already registered and do not specify to create a token. For more information see: [Create/Update](doc:create-update-users)