Authentication

Here, you will find information on endpoints related to token-based authentication, ensuring secure and protected access to our cloud software API.

Authenticates the user's credentials and, upon successful verification, issues an access token that can be used to authorize subsequent requests made to the API

POST/api/TokenAuth/Authenticate

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

userNameOrEmailAddress*string

password*string

twoFactorVerificationCodenullable string

rememberClientboolean

twoFactorRememberClientTokennullable string

singleSignInnullable boolean

returnUrlnullable string

captchaResponsenullable string

Response

200

Success

Body

text/plainapplication/jsontext/json

accessTokennullable string

encryptedAccessTokennullable string

expireInSecondsinteger (int32)

shouldResetPasswordboolean

passwordResetCodenullable string

userIdinteger (int64)

requiresTwoFactorVerificationboolean

twoFactorAuthProvidersnullable array of string

twoFactorRememberClientTokennullable string

returnUrlnullable string

refreshTokennullable string

refreshTokenExpireInSecondsinteger (int32)

cnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/TokenAuth/Authenticate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "password": "text",
      "userNameOrEmailAddress": "text"
    }),
});
const data = await response.json();

Response

200

{
  "accessToken": "text",
  "encryptedAccessToken": "text",
  "expireInSeconds": 0,
  "shouldResetPassword": false,
  "passwordResetCode": "text",
  "userId": 0,
  "requiresTwoFactorVerification": false,
  "twoFactorAuthProviders": [
    "text"
  ],
  "twoFactorRememberClientToken": "text",
  "returnUrl": "text",
  "refreshToken": "text",
  "refreshTokenExpireInSeconds": 0,
  "c": "text"
}

This endpoint allows for the renewal of the current access token, extending its validity period

POST/api/TokenAuth/RefreshToken

Query parameters

Response

200

Success

Body

text/plainapplication/jsontext/json

accessTokennullable string

encryptedAccessTokennullable string

expireInSecondsinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/TokenAuth/RefreshToken', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "accessToken": "text",
  "encryptedAccessToken": "text",
  "expireInSeconds": 0
}

Securely log out a user and invalidate the associated access token, effectively terminating the current session

GET/api/TokenAuth/LogOut

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/TokenAuth/LogOut', {
    method: 'GET',
    headers: {},
});
const data = await response.json();