Account API¶
Authentication¶
Authenticate a standard account¶
POST /account/authenticate
Request:
Name
Position
Type
Required
body
body
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
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
Request:
Name
Position
Type
Required
Response:
AuthenticateResponse3
AuthenticateRequest3¶
{// Requiredpassword : stringusername : string// OptionalhostName : stringtenantName : string}
AuthenticateResponse3¶
{// RequiredauthorizationToken : stringexpiresTimestamp : 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
required
Response:
void
AccountUnlockRequest¶
{// Requiredusername : string// OptionalhostName : stringtenantName : string}