Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Auth

Sign in a user

Authenticates a member with email and password. On success, returns the signed-in user profile (_id, email, name, image).

Required scopes: flex.user.auth.signin

post/api/v2/organizations/{orgSlug}/auth/signin

Path parameters

orgSlugstring required

organization slug

Request body

emailstring required

The email which was registered during signup as a login credential.

passwordstring required

The password which was registered during signup as a login credential.

Example request

{
  "email": "example@gmail.com",
  "password": "Pa$$w0rd"
}

Response

_idstring

The _id of the user.

emailstring

The email of the user.

namestring

The name of the user.

imagestring

The image of the user.

Example response

{
  "_id": "6a59d080856fad4ee4195303",
  "email": "example@gmail.com",
  "name": "John Doe",
  "image": "John Doe"
}