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
Body
userNameOrEmailAddressstring · min: 1 · max: 256Required
passwordstring · min: 1 · max: 32Required
twoFactorVerificationCodestring | nullableOptional
rememberClientbooleanOptional
twoFactorRememberClientTokenstring | nullableOptional
singleSignInboolean | nullableOptional
returnUrlstring | nullableOptional
captchaResponsestring | nullableOptional
Responses
200
Success
post
POST /api/TokenAuth/Authenticate HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 210

{
  "userNameOrEmailAddress": "text",
  "password": "text",
  "twoFactorVerificationCode": "text",
  "rememberClient": true,
  "twoFactorRememberClientToken": "text",
  "singleSignIn": true,
  "returnUrl": "text",
  "captchaResponse": "text"
}
200

Success

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

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

post
Query parameters
refreshTokenstringOptional
Responses
200
Success
post
POST /api/TokenAuth/RefreshToken HTTP/1.1
Host: 
Accept: */*
200

Success

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

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

get
Responses
200
Success
get
GET /api/TokenAuth/LogOut HTTP/1.1
Host: 
Accept: */*
200

Success

No content
PreviousBillingNextClusters

Last updated