Description and Details
This API is used to authenticate a user and issue an authentication token. It verifies the credentials (username and password or similar payload) provided by the user and returns an authentication token which can be used for further secured interactions with other APIs in the system.
Endpoint
https://api-dev-isolution.xyz/userauth
Verb Method
POST
Headers Request Parameters
Header Key | Value | Description |
---|---|---|
Content-Type | application/json | Specifies that the request body is JSON |
Accept | application/json | Expected response format |
Body Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
username | string | Yes | User’s login username or email |
password | string | Yes | User’s login password |
Response Parameters
Parameter | Type | Description |
---|---|---|
token | string | Authentication token (e.g., JWT or session) |
expires_in | integer | Expiry time of the token (in seconds) |
user_id | string | Unique identifier of the authenticated user |
user_roles | array | List of user roles or permissions |
HTTP Codes
Code | Meaning |
---|---|
200 | OK – Authentication successful |
400 | Bad Request – Missing or invalid input |
401 | Unauthorized – Invalid credentials |
403 | Forbidden – Access denied |
500 | Internal Server Error |