Authentication API

Login

This endpoint is used to authenticate a user and retrieve an access token.

URL: https://apis.rmlconnect.net/auth/v1/login/

  • Method: POST
  • Content-Type: application/json
  • Authentication Required: No

Request Headers

KeyValue
Content-Typeapplication/json
Cookiecsrftoken=<your-csrf-token> (Optional, if CSRF protection is enabled)

Request Parameters

FieldTypeDescription
usernamestringYour RML Connect username
passwordstringYour RML Connect password

Request Body

{
"username": "XXXXXX",
"password": "XXXXXX"
}

Response

Success (201 OK)

Returns authentication details (typically includes a token or session info).

Response-2

Invalid credentials or missing parameters.

{
"status": "invalid credentials or the account has been deactivated"
}

Error Responses

HTTP StatusDescriptionExample
400 Bad RequestMalformed request body or missing parameters{"detail": "Invalid JSON."}
401 UnauthorizedInvalid credentials or missing token{"detail": "Invalid username or password"}
403 ForbiddenToken is invalid or expired{"detail": "Authentication credentials were not provided."}
500 Internal Server ErrorServer-side error{"detail": "An unexpected error occurred."}

Session & Token Handling

  • Tokens are usually time-bound (1Hour). Ensure you handle token expiration by refreshing or prompting re-login.
  • Store tokens securely; avoid exposing them in URLs or client-side code.


Did this page help you?