Account API

Authentication

Authenticate a standard account

POST /account/authenticate

• Request:

  Name	Position	Type	Required
  body	body	AuthenticateRequest3	optional
  hostName	query	string	optional
  tenantName	query	string	optional

• Response:AuthenticateResponse3

Authenticate an admin account

POST /account/authenticateAdmin

• Request:

  Name	Position	Type	Required
  body	body	AuthenticateRequest3	optional
  hostName	query	string	optional
  tenantLocator	query	string	optional
  tenantName	query	string	optional

• Response:AuthenticateResponse3

Note

Values for hostName and tenantName can be included in either the query string or the AuthenticateRequest3

Renew an authentication token

POST /account/renewAuthentication

• Request:

  Name	Position	Type	Required

• Response:AuthenticateResponse3

AuthenticateRequest3

{
  // Required
  "password" : string
  "username" : string

  // Optional
  "hostName" : string
  "tenantName" : string
}

AuthenticateResponse3

{
  // Required
  "authorizationToken" : string
  "expiresTimestamp" : integer
}

Account Lockout Reset

Unlock an account that has been locked out due to failed login attempts

POST /account/unlock

• Request:

  Name	Position	Type	Required
  request	body	AccountUnlockRequest	required

• Response:void

AccountUnlockRequest

{
  // Required
  "username" : string

  // Optional
  "hostName" : string
  "tenantName" : string
}