Create Anonymous Session

v1.0.0

Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its or create an .

Output

{
  "type": "object",
  "description": "Session",
  "required": [
    "$id",
    "clientCode",
    "clientEngine",
    "clientEngineVersion",
    "clientName",
    "clientType",
    "clientVersion",
    "countryCode",
    "countryName",
    "current",
    "deviceBrand",
    "deviceModel",
    "deviceName",
    "expire",
    "ip",
    "osCode",
    "osName",
    "osVersion",
    "provider",
    "providerToken",
    "providerUid",
    "userId"
  ],
  "properties": {
    "$id": {
      "type": "string",
      "description": "Session ID."
    },
    "clientCode": {
      "type": "string",
      "description": "Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json)."
    },
    "clientEngine": {
      "type": "string",
      "description": "Client engine name."
    },
    "clientEngineVersion": {
      "type": "string",
      "description": "Client engine name."
    },
    "clientName": {
      "type": "string",
      "description": "Client name."
    },
    "clientType": {
      "type": "string",
      "description": "Client type."
    },
    "clientVersion": {
      "type": "string",
      "description": "Client version."
    },
    "countryCode": {
      "type": "string",
      "description": "Country two-character ISO 3166-1 alpha code."
    },
    "countryName": {
      "type": "string",
      "description": "Country name."
    },
    "current": {
      "type": "boolean",
      "description": "Returns true if this the current user session."
    },
    "deviceBrand": {
      "type": "string",
      "description": "Device brand name."
    },
    "deviceModel": {
      "type": "string",
      "description": "Device model name."
    },
    "deviceName": {
      "type": "string",
      "description": "Device name."
    },
    "expire": {
      "type": "integer",
      "format": "int32",
      "description": "Session expiration date in Unix timestamp."
    },
    "ip": {
      "type": "string",
      "description": "IP in use when the session was created."
    },
    "osCode": {
      "type": "string",
      "description": "Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json)."
    },
    "osName": {
      "type": "string",
      "description": "Operating system name."
    },
    "osVersion": {
      "type": "string",
      "description": "Operating system version."
    },
    "provider": {
      "type": "string",
      "description": "Session Provider."
    },
    "providerToken": {
      "type": "string",
      "description": "Session Provider Token."
    },
    "providerUid": {
      "type": "string",
      "description": "Session Provider User ID."
    },
    "userId": {
      "type": "string",
      "description": "User ID."
    }
  }
}