Authentication

Guardian authentication operations

Guardian login

post

https://api.example.com/v1https://staging-api.example.com/v1

/guardian/login

Authenticate guardian member with email and password

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstring · emailRequired

Guardian's email address

passwordstringRequired

Guardian's password

Responses

200

Login successful

application/json

400

Validation error

application/json

401

Invalid credentials

500

Internal server error

application/json

post

/guardian/login

HTTPcURLJavaScriptPython

POST /v1/guardian/login HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[email protected]",
  "password": "text"
}

{
  "success": true,
  "message": "Login successful",
  "data": {
    "token": "text"
  }
}

Guardian logout

post

https://api.example.com/v1https://staging-api.example.com/v1

/guardian/logout

Logout guardian member and clear session

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Logout successful

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

post

/guardian/logout

HTTPcURLJavaScriptPython

POST /v1/guardian/logout HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Logged out successfully"
}