GET Methods #
Get Account #
Description
Gets the currently authenticated user account information.
Route
/Accounts/
Authentication
This service is secure and requires authentication headers
Example Response
{
"userId": 1,
"firstName": "first",
"lastName": "last",
"emailAddress": "email@address.com",
"userName": "username",
"language": "en_us",
"timezone": "America\/New_York",
"phone": "phone",
"organization": "organization",
"position": "position",
"customAttributes": [
{
"id": 123,
"label": "label",
"value": "value",
"links": [],
"message": null
}
],
"icsUrl": "webcal:\/\/path-to-calendar",
"links": [],
"message": null
}POST Methods #
Register Account #
Description
Register a user account. This does not authenticate the account.
Route
/Accounts/Registration
Authentication
This service does not require authentication headers
Example Request
{
"password": "plaintextpassword",
"acceptTermsOfService": true,
"firstName": "FirstName",
"lastName": "LastName",
"emailAddress": "email@address.com",
"userName": "username",
"language": "en_us",
"timezone": "America\/New_York",
"phone": "phone",
"phoneCountryCode": null,
"organization": "organization",
"position": "position",
"customAttributes": [
{
"attributeId": 1,
"attributeValue": "attribute value"
}
]
}Example Response
{
"userId": 1,
"links": [
{
"href": "http:\/\/url\/to\/account",
"title": "get_user_account"
},
{
"href": "http:\/\/url\/to\/update\/account",
"title": "update_user_account"
}
],
"message": null
}Update Account #
Description
Updates the user account for the current user.
Route
/Accounts/
Authentication
This service is secure and requires authentication headers
Example Request
{
"firstName": "FirstName",
"lastName": "LastName",
"emailAddress": "email@address.com",
"userName": "username",
"language": "en_us",
"timezone": "America\/New_York",
"phone": "phone",
"phoneCountryCode": "US",
"organization": "organization",
"position": "position",
"customAttributes": [
{
"attributeId": 1,
"attributeValue": "attribute value"
}
]
}Example Response
{
"userId": 1,
"links": [
{
"href": "http:\/\/url\/to\/account",
"title": "get_user_account"
},
{
"href": "http:\/\/url\/to\/update\/account",
"title": "update_user_account"
}
],
"message": null
}Update Password #
Description
Updates the password for the current user .
Route
/Accounts/Password/
Authentication
This service is secure and requires authentication headers
Example Request
{
"currentPassword": "plain.text.current.password",
"newPassword": "plain.text.new.password"
}Example Response
{
"userId": 1,
"links": [
{
"href": "http:\/\/url\/to\/account",
"title": "get_user_account"
},
{
"href": "http:\/\/url\/to\/update\/account",
"title": "update_user_account"
}
],
"message": null
}
