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

Note

Use /authenticate for authenticating as a regular user (in which case you must specify a tenantName or hostName), or for an administration account for deploying configurations (in which case you should not specify a tenantName or hostName.)

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

Use /authenticateAdmin for authenticating as a “tenant administrator.” It’s the equivalent of logging in as an administrator in the Socotra Administration UI to modify users, maintain external integrations, and query plugin logs. You must specify one of the tenantLocator, hostName, or tenantName. This type of account token cannot be used to deploy configurations.

Note

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

Renew an authentication token

POST /account/renewAuthentication

• Response:AuthenticateResponse3

AuthenticateRequest3

{
  // Required
  password : string
  username : string

  // Optional
  hostName : string
  tenantName : string
}

AuthenticateResponse3

{
  // Required
  authorizationToken : string
  expiresTimestamp : timestamp
}

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

Note

To unlock any account you must be authenticated as an admin user.

AccountUnlockRequest

{
  // Required
  username : string

  // Optional
  hostName : string
  tenantName : string
}

Note

To unlock a tenant user account you must specify both the username and hostname in the request. To unlock another admin user you must specify only the username.