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

username stringrequired

Possible values: non-empty

Responses

200

OK

application/json

Schema

Schema

data

object

avatarUrl url

Link of user's avatar

orgName string

Name of the organization that the user belongs to

refreshToken stringrequired

Refresh token used for subsequent API requests

token stringrequired

Token used for authentication in API requests

username string

Name of the user

Example (from schema)

{
  "data": {
    "avatarUrl": "https://developers.inspectorio.com/img/user.png",
    "orgName": "Acme Corp",
    "refreshToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N123...xyz",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N123...abc",
    "username": "John Doe"
  }
}

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"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

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...