1min

Login

POST
Log into an existing Violet account with a username and password. If sucessful an access token will be returned in the response body for use in additional requests against the API.
HEADER PARAMETERS
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
LoginRequest
Login Request
usernamestring
User Email Address
passwordstring
User Password
RESPONSES
200
successful operation
LoginResponse
Login Response
idinteger<int64>
first_namestring
The users first name
last_namestring
The users last name
passwordstring
The users raw desired password
emailstring
The users unique email address
merchant_idinteger<int32>
The Id of the Store the User is associated to.
typestring<ADMIN | MERCHANT | USER | DEVELOPER>
The allowed values for the user type
verifiedboolean
If a user has verified their emailed address
statusstring<INACTIVE | ACTIVE | DISABLED>
The status of the user
date_createdstring<date-time>
Date of account creation
date_last_modifiedstring<date-time>
Date of last account update
roles
Role[]
tokenstring
Users Access Token. Currently expires after 1440 minutes.
refresh_tokenstring
Users Refresh Token. Never expires.
Updated 21 Apr 2022
Did this page help you?
Yes
No