Create Account Session

POST

/account/sessions

account

Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://appwrite.io/v1/account/sessions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "password": "string"
}'

Response Example

{
    "$id": "string",
    "clientCode": "string",
    "clientEngine": "string",
    "clientEngineVersion": "string",
    "clientName": "string",
    "clientType": "string",
    "clientVersion": "string",
    "countryCode": "string",
    "countryName": "string",
    "current": true,
    "deviceBrand": "string",
    "deviceModel": "string",
    "deviceName": "string",
    "expire": 0,
    "ip": "string",
    "osCode": "string",
    "osName": "string",
    "osVersion": "string",
    "provider": "string",
    "providerToken": "string",
    "providerUid": "string",
    "userId": "string"
}

Request

Body Params application/json

string

required

User email.

password

string

required

User password. Must be between 6 to 32 chars.

Examples

Responses

🟢201Session

application/json

Body

Session

$id

string

required

Session ID.

clientCode

string

required

Client code name. View list of available options.

clientEngine

string

required

Client engine name.

clientEngineVersion

string

required

Client engine name.

clientName

string

required

Client name.

clientType

string

required

Client type.

clientVersion

string

required

Client version.

countryCode

string

required

Country two-character ISO 3166-1 alpha code.

countryName

string

required

Country name.

current

boolean

required

Returns true if this the current user session.

deviceBrand

string

required

Device brand name.

deviceModel

string

required

Device model name.

deviceName

string

required

Device name.

expire

integer <int32>

required

Session expiration date in Unix timestamp.

string

required

IP in use when the session was created.

osCode

string

required

Operating system code name. View list of available options.

osName

string

required

Operating system name.

osVersion

string

required

Operating system version.

provider

string

required

Session Provider.

providerToken

string

required

Session Provider Token.

providerUid

string

required

Session Provider User ID.

userId

string

required

User ID.

Modified at 2023-08-16 07:28:13

Get Account Sessions

Create Anonymous Session