{"_id":"5449159bcdc944220048845f","user":"54352decadf50e0800b89024","is_link":false,"editedParams2":true,"editedParams":true,"parentDoc":null,"project":"543d1e263a300f20000d31fb","version":{"_id":"543d1e5e5276641a00a593cf","forked_from":"543d1e263a300f20000d31fe","project":"543d1e263a300f20000d31fb","__v":16,"createdAt":"2014-10-14T13:00:14.946Z","releaseDate":"2014-10-14T13:00:14.946Z","categories":["543d1e5f5276641a00a593d0","543d1ee45276641a00a593da","5448e2cbc64edd1a00453c29","5449135acdc944220048845c","544a0a93778b3e08002b2289","544a0a9727b7fc140078da58","544a456f27b7fc140078daff","544e027cbd51b9080037f680","544e029ab80812080035bba6","544e3a2eb80812080035bd67","5450b7c5a66f020800dba7b3","5450c0e47abbbc0800a5e989","5450c0f97abbbc0800a5e98a","5450c103a66f020800dba819","54f99f588d09b7390007ea45","565c81dbf3e9360d00823e43"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":0,"category":{"_id":"5449135acdc944220048845c","__v":4,"pages":["5449159bcdc944220048845f","544a04bd27b7fc140078da46","544a07c3778b3e08002b2279","544a089d778b3e08002b2281"],"project":"543d1e263a300f20000d31fb","version":"543d1e5e5276641a00a593cf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-23T14:40:26.897Z","from_sync":false,"order":2,"slug":"session","title":"Session"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-23T14:50:03.190Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"token\": \"00i1m74tht1p4391\",\n    \"reference\": \"Ri1n74thtuc\",\n    \"expires\": \"2014-10-30T14:19:34+0000\",\n    \"user\": null,\n    \"permissions\": {\n        \"guest\": [\"api.public\", \"api.users.create\"]\n    },\n    \"provider\": null,\n    \"client_id\": \"00i1m74thtzd84czv848f4c1zezztolj\"\n}","language":"json","status":201}]},"try":true,"basic_auth":false,"method":"post","auth":"never","params":[{"_id":"5449159bcdc9442200488464","ref":"","in":"body","required":true,"desc":"Your API key.","default":"","type":"string","name":"api_key"},{"_id":"5449159bcdc9442200488463","ref":"","in":"body","required":false,"desc":"Time To Live in seconds.","default":"604800","type":"int","name":"token_ttl"},{"_id":"5449159bcdc9442200488462","ref":"","in":"body","required":false,"desc":"The identity string of your client. See below.","default":"","type":"string","name":"client_id"},{"_id":"5449159bcdc9442200488461","ref":"","in":"body","required":false,"desc":"Email of user to log in.","default":"","type":"string","name":"email"},{"_id":"5449159bcdc9442200488460","ref":"","in":"body","required":false,"desc":"Password of user to log in.","default":"","type":"string","name":"password"}],"url":"/v2/sessions"},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Client Id\"\n}\n[/block]\nThe client id identifies your client.\nIf you don't yet have a client id, you can create session without it.\nThe server will auto-generate a client id for you.\n\n**Store the client id**. You will need it to make future session create requests.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User Login\"\n}\n[/block]\nYou can do a user login on session create.\nIt is not required, but can be convenient if you already know the user credentials before you create your session.","excerpt":"","slug":"session-create","type":"endpoint","title":"Session Create"}

postSession Create


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

api_key:
required
string
Your API key.
token_ttl:
integer604800
Time To Live in seconds.
client_id:
string
The identity string of your client. See below.
email:
string
Email of user to log in.
password:
string
Password of user to log in.

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Client Id" } [/block] The client id identifies your client. If you don't yet have a client id, you can create session without it. The server will auto-generate a client id for you. **Store the client id**. You will need it to make future session create requests. [block:api-header] { "type": "basic", "title": "User Login" } [/block] You can do a user login on session create. It is not required, but can be convenient if you already know the user credentials before you create your session.