Login and Retrieve Access Token

POST 
/api/v1/auth/login

deprecated

Login and Retrieve Access Token

Request

application/json

Body

password stringrequired

Possible values: non-empty

Password of the user used to retrieve access token, e.g. acme123

username stringrequired

Possible values: non-empty

Username of the user used to retrieve access token, e.g. [email protected]

Responses

200

OK

application/json

Schema

Schema

data

object

orgName string

Name of the organization the user belongs to

token stringrequired

Authentication token used for every API request

Example (from schema)

{
  "data": {
    "orgName": "Acme Corp",
    "token": "8847eae8-9ef1-123-abc"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...