Login

POST 
/auth

The Login request allows users to authenticate themselves with ANSCER ANYA by providing their email address and password. This request does not require any additional parameters and can be accessed by any unauthenticated user.

To use this request, you need to provide your email address and password to ANSCER ANYA and send the request to the API endpoint. Once the request is sent, ANSCER ANYA will verify your credentials and return a JSON Web Token (JWT) that can be used to authenticate subsequent requests.

Request

application/json

Body

required

email emailrequired

Possible values: >= 5 characters and <= 255 characters

password stringrequired

Possible values: >= 6 characters and <= 255 characters

Responses

200

User logged in

Response Headers

• x-auth-token string

  JWT token

application/json

Schema

Schema

_id uuid
name string

Possible values: >= 3 characters and <= 50 characters

email email

Possible values: >= 5 characters and <= 255 characters

role userRoles

Possible values: [developer, admin, user]

token string

JWT token

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "email": "user@example.com",
  "role": "developer",
  "token": "string"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "email",
      "message": "Email must be a valid email address."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "email",
      "message": "Email must be a valid email address."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    }
  ]
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...