users

Sign in to account.

This endpoint will sign in a user to their account.

post/users/signin

Request

  • Base URL
    https://api.kurozora.app/v1
  • URL
    https://api.kurozora.app/v1/users/signin
  • Auth
    none declared

Request body application/x-www-form-urlencoded

emailstring required

The user's email address

passwordstring required

The user's password

platformstring required

The platform that was used to create the session

platform_versionstring required

The platform version that was used to create the session

device_vendorstring required

The device vendor that was used to create the session

device_modelstring required

The device model that was used to create the session

Example request

{
  "platform": "iOS",
  "platform_version": "13.4",
  "device_vendor": "Apple",
  "device_model": "iPhone 11 Pro Max"
}

Response

Successful POST Sessions JSON response

object required

Example response

{
  "data": [
    {
      "id": 24,
      "type": "sessions",
      "href": "/v1/sessions/24",
      "attributes": {
        "ip": "127.0.0.1",
        "lastValidatedAt": "2020-08-04 22:51:58"
      },
      "authToken": "AuthenticationToken",
      "relationships": {
        "user": {
          "data": [
            {
              "id": 2,
              "type": "users",
              "href": "/v1/users/2/profile",
              "attributes": {
                "username": "Kirito",
                "activityStatus": "Online",
                "biography": "An interesting biography.",
                "profileImageURL": "https://kurozora-cdn.app/2/ProfileImage.png",
                "bannerImageURL": "https://kurozora-cdn.app/2/BannerImage.png",
                "followerCount": 10,
                "followingCount": 12,
                "reputationCount": 14
              }
            }
          ]
        },
        "platform": {
          "data": [
            {
              "description": "iPhone 11 Pro Max on iOS 13.4",
              "systemName": "iOS",
              "systemVersion": "13.4",
              "deviceVendor": "Apple",
              "deviceModel": "iPhone 11 Pro Max"
            }
          ]
        },
        "location": {
          "data": [
            {
              "city": "Amsterdam",
              "region": "Amsterdam",
              "country": "Netherlands",
              "latitude": 52.35997,
              "longitude": 4.86352
            }
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.