Skip to main content
POST
Sign in

Body

application/json
email
string<email>
required

User's email address

Example:

"user@example.com"

password
string
required

User's password

Example:

"SecurePass123!"

role
enum<string>
required

Role to sign in as

Available options:
ROLE_ADMIN,
ROLE_PLATFORM_ADMIN,
ROLE_PLATFORM_USER
Example:

"ROLE_PLATFORM_ADMIN"

Response

Sign in successful

msg
string
required

Human-readable message describing the result

Example:

"Sign In Successful!"

data
object
required

Response payload (null on error)