Skip to main content
POST
/
api
/
auth
/
signin
Sign in
curl --request POST \
  --url https://payments.oaknetwork.org/api/auth/signin \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "SecurePass123!",
  "role": "ROLE_PLATFORM_ADMIN"
}
'
{
  "msg": "Sign In Successful!",
  "data": {
    "id": 123,
    "email": "jsmith@example.com",
    "accessToken": "<string>",
    "refreshToken": "<string>",
    "createdMillis": 123
  }
}

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)