🔑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
userNamestring | nullableOptional
passwordstring | nullableOptional
Responses
200

Success

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

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

Success

No content
post
Body
namestring | nullableOptional
emailstring | nullableOptional
passwordstring | nullableOptional
toSbooleanOptional
Responses
200

Success

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

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

Success

No content

Refresh / Revoke Sessions

post
Query parameters
refreshTokenstringOptional
Responses
200

Success

No content
post
/auth/refreshtoken
POST /auth/refreshtoken HTTP/1.1
Host: 
Accept: */*
200

Success

No content
post
Query parameters
refreshTokenstringOptional
Responses
200

Success

No content
post
/auth/revoketoken
POST /auth/revoketoken HTTP/1.1
Host: 
Accept: */*
200

Success

No content
get
Responses
200

Success

No content
get
/account/overview
GET /account/overview HTTP/1.1
Host: 
Accept: */*
200

Success

No content

Reset Password Workflow

post
Body
emailstring | nullableOptional
Responses
200

Success

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

{
  "email": "text"
}
200

Success

No content
post
Body
tokenstring | nullableOptional
newPasswordstring | nullableOptional
Responses
200

Success

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

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

Success

No content
PreviousAPI ReferenceNextApi Keys

Last updated