Authenticate

* Required field: userNameOrEmailAddress , password

Use API to get token: /api/TokenAuth/Authenticate

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)

Request

JavaScriptCurl

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

{
  "accessToken": "text",
  "encryptedAccessToken": "text",
  "shouldResetPassword": false,
  "passwordResetCode": "text",
  "requiresTwoFactorVerification": false,
  "twoFactorAuthProviders": [
    "text"
  ],
  "twoFactorRememberClientToken": "text",
  "returnUrl": "text",
  "refreshToken": "text"
}

POST/api/TokenAuth/RefreshToken

Query parameters

Response

200

Success

Body

text/plainapplication/jsontext/json

accessTokennullable string

encryptedAccessTokennullable string

expireInSecondsinteger (int32)

Request

JavaScriptCurl

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

Response

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

GET/api/TokenAuth/LogOut

Response

200

Success

Request

JavaScriptCurl

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

POST/api/TokenAuth/SendTwoFactorAuthCode

Body

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

userIdinteger (int64)

provider*string

Response

200

Success

Request

JavaScriptCurl

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