Auth

login with email and password

Auth: None (appId required; legacy App JWT accepted)

End user login endpoint, should be used with Authorization header set to App JWT. Ethora App JWT example: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7Il9pZCI6IjYxZTU1YzlkOTBlYTk5NTk0YmM3ZTZhMiIsImFwcE5hbWUiOiJFdGhvcmEiLCJhcHBHb29nbGVJZCI6Ijk3MjkzMzQ3MDA1NC1oYnNmMjlvaHBhdG83NnRpbDJqdGY2amdnMWI0Mzc0Yy5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsImNyZWF0b3JJZCI6IjYyYzNmNGE5M2FkMjcwNjc0YzFmNjJmYiIsImNyZWF0ZWRBdCI6IjIwMjItMDctMDVUMDg6Mjc6MjYuMzM2WiIsIl9fdiI6MH0sImlhdCI6MTY1NzAwOTY1OH0.dnvrO_dQ_2GLyUX-b71CcHFDnphpjeTYOxz6vZ2fsPY

Provide appId in the request body to resolve app context. Legacy Authorization app token is also accepted for backward compatibility.

post/v1/users/login-with-email

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v1/users/login-with-email
  • Auth: none required

Request body

emailstring

Account email address. Must match an existing user under the calling app context.

passwordstring

Account password. 8+ characters in practice; weaker passwords are rejected with WRONG_CREDENTIALS.

appIdstring

Application id used to resolve tenant/app context.

Response 

{
  success: boolean,
  user: {
    defaultWallet: {
      walletAddress: string
    },
    isSuperAdmin: {
      read: boolean,
      write: boolean
    },
    _id: string,
    firstName: string,
    lastName: string,
    email: string,
    username: string,
    tags: string[],
    profileImage: string,
    emails: [
      {
        loginType: string,
        email: string,
        verified: boolean,
        _id: string
      }
    ],
    appId: string,
    xmppPassword: string,
    roles: string[],
    isProfileOpen: boolean,
    isAssetsOpen: boolean,
    isAgreeWithTerms: boolean,
    homeScreen: string,
    registrationChannelType: string,
    createdAt: string,
    updatedAt: string
  },
  token: string,
  refreshToken: string
}
successboolean required
tokenstring required
refreshTokenstring required
wsTokenstring
isAllowedNewAppCreateboolean nullable

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.