Login with Twitter
    • Dark
      Light
    • PDF

    Login with Twitter

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/login - with Twitter

    Changelog

    VersionDescription
    1.0.0Added avatarUrl property to response
    0.64.0Added me property.
    0.63.0Added
    Body parameters
    Example
    {
      "serviceName": "twitter",
      "accessToken": "hash",
      "accessTokenSecret": "hash",
      "appSecret": "hash",
      "appId": "hash",
      "expiresIn": 200
    }
    object
    serviceName
    string Required

    The desired OAuth service name. In this case, twitter.

    Exampletwitter
    accessToken
    string Required

    Access token provided by Twitter OAuth.

    Examplehash
    accessTokenSecret
    string Required

    The access token secret provided by Twitter OAuth.

    Examplehash
    appSecret
    string Required

    The app secret provided by Twitter.

    Examplehash
    appId
    string Required

    The app ID provided by Twitter.

    Examplehash
    expiresIn
    integer Required

    Lifetime of token (in seconds).

    Example200
    Responses
    200
    Success Example
    {
      "status": "success",
      "data": {
        "authToken": "9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq",
        "userId": "aobEdbYhXfu5hkeqG",
        "me": {
          "_id": "aYjNnig8BEAWeQzMh",
          "name": "Rocket Cat",
          "emails": [
            {
              "address": "[email protected]",
              "verified": false
            }
          ],
          "status": "offline",
          "statusConnection": "offline",
          "username": "rocket.cat",
          "utcOffset": -3,
          "active": true,
          "roles": [
            "admin"
          ],
          "settings": {
            "preferences": {}
          },
          "avatarUrl": "http://localhost:3000/avatar/test"
        }
      }
    }
    Expand All
    object
    status
    string
    data
    object
    authToken
    string
    userId
    string
    me
    object
    _id
    string
    name
    string
    emails
    Array of object
    object
    address
    string
    verified
    boolean
    status
    string
    statusConnection
    string
    username
    string
    utcOffset
    integer
    active
    boolean
    roles
    Array of string
    string
    settings
    object
    preferences
    object
    avatarUrl
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.