Sqabl APIs
  1. APIs
Sqabl APIs
  • APIs
    • Auth
      • Sign Up
      • Sign In
      • Sign Out
      • Refresh Access Token
      • Get user by token
      • Change password
    • OTP
      • Verify OTP
      • Generate OTP
      • OTP Status
    • User
      • Get user
      • Get user by token
      • Update user
      • Get user's followers
      • Get user's followees
      • Get user's referred members
      • Get user's interacted items
      • Get user's bookmarks
      • Flag a user
      • Follow user
      • Unfollow user
      • Block a user
      • Unblock a user
      • Delete user's picture
      • Delete user
    • Users
      • Get users
    • Arenas
      • Get arenas
      • Create an arena
      • Invite users to arenas
    • Arena
      • Get arena
      • Update arena
      • Join an arena
      • Leave an arena
      • Get arena members
      • Add users to arena
      • Remove members from an arena
      • Update an arena member
    • Posts
      • Get posts
      • Create a post
    • Post
      • Get a post
      • Update a post
      • Delete a post
      • Flag a post
      • Flame a post
      • Unflame a post
      • Save a post
      • Unsave a post
      • Hide a post
      • Get post participants
      • Participate in a post
      • Get post comments
      • Comment on a post
    • Comment
      • Get comment
      • Delete a comment
      • Flag a comment
      • Flame a comment
      • Unflame a comment
      • Save a comment
      • Unsave a comment
    • Alerts
      • Get user's alerts
      • Mark some or all alerts read
    • Flags
      • get flags
    • Faqs
      • get faqs
    • Interests
      • get interests
    • Search
      • get popular search keywords
    • Signed Upload URL
      • get signed url for upload
  1. APIs

Auth

The Auth Folder comprises of the following endpoints necessary for user creation, authentication and authorization.
Sign In
Sign Up

1. Sign Up (/auth/sign-up/)#

An endpoint to initiate user's registration.
Once all requirements are satisfied, an OTP should be generated and sent to the registered email, if the "authType"="password".
Registration isn't complete if the OTP hasn't been verified, in fact, if while that hasn't been verified and the request on "sign-up" is repeated with the same email address, it won't give an error but should only update the OTP code.
However, if the OTP has been verified and the a "sign-up" request is made again, with the same email address, then an error shall occur; that an email is unique to an instance alone.
If the "authType"="provider", OTP is not needed; it's believed the verification has been done at the client-side, backed with another authentication at the server-side; only the Headers "Authorization" is required.

2. Sign In (/auth/sign-in/)#

Authenticate a registered user with this endpoint, with the required params.

3. Authenticate a User (/auth/)#

Ensure you check the required params of each endpoint you need to invoke.
Previous
APIs
Next
Sign Up
Built with