Skip to main content

Login

Authentication

  • API Key (Token)
    • Parameter Name: Authorization, in: header. Authorization header token.

      Example: "Bearer abcdefghijklmnopqrstuvwxyz01234567890abcdefghijklmnopqrstuvwxyz01234567890"

Login

post__login

Code samples

POST /login HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /login

Body parameter

{
  "Username": "string",
  "Password": "string",
  "TwoFactorAuthenticationToken": "string",
  "EmailVerficationUpdatedEmailAddress": "string",
  "EmailVerificationToken": "string",
  "InactivityTimeoutInMinutes": 0
}

Parameters

Name In Type Required Description
body body AuthenticateElement false none

Example responses

200 Response

{
  "SessionToken": "string",
  "UserEmailAddress": "string",
  "Status": "Ok",
  "Details": "string"
}

401 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success AuthenticationResult
401 Unauthorized Unauthorized string

post__resetpassword

Code samples

POST /resetpassword HTTP/1.1

Content-Type: application/json-patch+json

POST /resetpassword

Body parameter

{
  "Username": "string",
  "Email": "string"
}

Parameters

Name In Type Required Description
body body ResetPasswordElement false none

Responses

Status Meaning Description Schema
200 OK Success None