Account API

Endpoint Index

ActionEndpoint
Authenticate a standard accountPOST /account/authenticate
Authenticate an admin accountPOST /account/authenticateAdmin
Renew an authentication tokenPOST /account/renewAuthentication
Unlock an account that has been locked out due to failed login attemptsPOST /account/unlock
Update a passwordPATCH /account/v1/accounts/password

Authentication

Authenticate a standard account
POST /account/authenticate

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

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 AuthenticateRequest

Renew an authentication token
POST /account/renewAuthentication
AuthenticateRequest
required
password string
username string

optional
hostName string
tenantName string
AuthenticateResponse
required
expiresTimestamp timestamp
authorizationToken string

Account Lockout Reset

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

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.

Password Change

A user can change their password with the following endpoint:

Update a password
PATCH /account/v1/accounts/password
PasswordChangeRequest
required
oldPassword string
password string

Note

Note that the path for the above endpoint is /accounts and not /account.