post https://bo-api.drivewealth.io/back-office/auth
This document is NOT to be used by developers who are utilizing the new authentication method.
If you are a developer who needs to create an authentication token using v2, please click here.
Results Explained
| Attribute | Type | Description |
|---|---|---|
username | string | username of the back office user |
authToken | string | current valid authentication for the user |
expiresAt | string | timestamp of when the authToken expires |
security | object | |
security.description | string | description of the permission set applied to the user |
security.permissionSet | array | array containing all active permissions granted under the users permissionID |
security.permissionID | string | permission group identifier |
userID | string | user identifier of the back office user |
firstName | string | back office user first name |
lastName | string | back office user last name |
parentIBID | string | back office users parent introducing account |