Skip to main content

Authentication API (1.15.0)

Download OpenAPI specification:Download

Monitr's Authentication API

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

JWK

Get a list of JWKs

A list of public JSON Web Keys (JWK) used for JWT verification.

Responses

User

Login with username/password an optional OTP token

Request Body schema: application/json
email
required
string <email>
password
required
string
otp
string 6 characters

Responses

Request samples

Content type
application/json
{
  • "email": "email@example.com",
  • "password": "string",
  • "otp": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "refreshToken": "string"
}

Request a registration

Request Body schema: application/json
One of
invite
string
email
required
string <email>
firstName
required
string
lastName
required
string
companyName
string
consentMarketing
boolean

Responses

Request samples

Content type
application/json
{
  • "invite": "string",
  • "email": "email@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "consentMarketing": true
}

Finish the registration

Request Body schema: application/json
password
required
string
emailToken
required
string
object

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "emailToken": "string",
  • "invite": {
    }
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "refreshToken": "string"
}

Request a forgot password email

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "email@example.com"
}

Reset a password using a password reset token

Request Body schema: application/json
password
required
string
resetToken
required
string
otp
string 6 characters

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "resetToken": "string",
  • "otp": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "refreshToken": "string"
}

MFA

Request MFA enrollment

Authorizations:
Request Body schema: application/json
type
required
string
Value: "token:software:totp"

Responses

Request samples

Content type
application/json
{
  • "type": "token:software:totp"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Submit MFA enrollment

Authorizations:
Request Body schema: application/json
token
required
string
code
required
string 6 characters

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "code": "string"
}