Account Manager Authentication
POST /api/v2/security/authenticate
The Account Manager requires an authentication token that must be passed with all API requests. The authenticate API uses a POST request to generate that token based on a user’s login information. The token expires over time, at which point you will receive an unauthorized response and must request a new token.
Resource URL
https://authws.alk.com/api/v2/security/authenticate
Request
POST Body:
| Name | Description | Data Type | Required |
|---|---|---|---|
email
| The username, usually an email address. |
string | Y |
password
| The log in password. |
string | Y |
account
| The company name on the account. |
string | N |
product
| The Trimble Maps web product you are accessing. |
string | N |
Response
| Name | Description | Data Type |
|---|---|---|
userId
| The Trimble Maps internal user Id |
Alphanumeric |
username
| The username |
string |
authToken
| The token to be used in subsequent API requests |
Alphanumeric |
accountName
| The company name on the account |
string |
accountId
| The account Id |
Int |
firstName
| The user’s first name |
string |
lastName
| The user’s last name |
string |
roles
| The user’s role assignment in the web product (e.g. User, Company Administrator, etc.) |
string |
currentTermsAccepted
| Indicates whether the Administrator has accepted the terms and conditions of use |
int |
Sample Request
{
"email": "slopez@example.com",
"password": "Password!234",
"product": "Account Management",
"account": "Example Corp"
}
Sample Response
{
"userId": 4942928,
"username": "slopen@example.com",
"authToken": "vt9buDd6mv8bdj48j6yWcmKakSn7f8me",
"accountName": "Example Corp",
"accountId": 1,
"firstName": "Stan",
"lastName": "Lopez",
"roles": ["Company Administrator"],
"currentTermsAccepted": 1
}