🔑Authorization

Good to know: All the methods shown below are synced to an example Swagger file URL and are kept up to date automatically with changes to the API.

Login / Registration

post

Body

application/jsontext/jsonapplication/*+json

userNamestring | nullableOptional

passwordstring | nullableOptional

Responses

200

Success

No content

post

/auth

HTTPcURLJavaScriptPython

POST /auth HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "userName": "text",
  "password": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

No content

post

Body

application/jsontext/jsonapplication/*+json

namestring | nullableOptional

emailstring | nullableOptional

passwordstring | nullableOptional

toSbooleanOptional

Responses

200

Success

No content

post

/auth/register

HTTPcURLJavaScriptPython

POST /auth/register HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "text",
  "email": "text",
  "password": "text",
  "toS": true
}

application/jsontext/jsonapplication/*+json

200

Success

No content

Refresh / Revoke Sessions

post

Query parameters

refreshTokenstringOptional

Responses

200

Success

No content

post

/auth/refreshtoken

HTTPcURLJavaScriptPython

POST /auth/refreshtoken HTTP/1.1
Host: 
Accept: */*

200

Success

No content

post

Query parameters

refreshTokenstringOptional

Responses

200

Success

No content

post

/auth/revoketoken

HTTPcURLJavaScriptPython

POST /auth/revoketoken HTTP/1.1
Host: 
Accept: */*

200

Success

No content

get

Responses

200

Success

No content

get

/account/overview

HTTPcURLJavaScriptPython

GET /account/overview HTTP/1.1
Host: 
Accept: */*

200

Success

No content

Reset Password Workflow

post

Body

application/jsontext/jsonapplication/*+json

emailstring | nullableOptional

Responses

200

Success

No content

post

/auth/requestreset

HTTPcURLJavaScriptPython

POST /auth/requestreset HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "email": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

No content

post

Body

application/jsontext/jsonapplication/*+json

tokenstring | nullableOptional

newPasswordstring | nullableOptional

Responses

200

Success

No content

post

/auth/resetpassword

HTTPcURLJavaScriptPython

POST /auth/resetpassword HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "token": "text",
  "newPassword": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

No content