*User Management
Swagger: https://user.telematicssdk.com/swagger/index.html
Production URL: https://user.telematicssdk.com
Get user details
Address: /v1/Management/Users/Find
Method: GET
Authorization: Required with API Authorization Credentials
Request headers:
"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)Request
Query parameters (at least one of these is required):
DeviceToken = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
Email = "string";
Phone = "string";
ClientId = "string";
Country = "string";
OsType = "android", // { "android" = 0, "iOS" = 1 }
FullName = "string";
FirstName = "string";
LastName = "string";
IncludeAccountInfo = true; // default = false
ShowInactiveUsers = false; // default = falseResponse
Update user details
Address: /v1/Management/Users
Method: PUT
Authorization: Required with API Authorization Credentials
Request Headers:
Request
Response
Delete user
Address: /v1/Management/Users/{DeviceToken}
Method: DELETE
Authorization: Required with API Authorization Credentials
Request headers:
Request
Transfer user to another InstanceID
Allows to change user instance inside application.
Address: /v1/Management/users/instances/change
Method: POST
Authorization: Required with API Authorization Credentials
Request headers:
Request
Response
Transfer user to another instance with a Company Invitation Code
Transfer user to another InstanceID with a Company Invitation Code
Allows to change user instance inside application.
Address: /v1/Management/users/instances/change/{InstanceInviteCode}
Method: POST
Authorization: Required as User
url parameter: InstanceInviteCode = "someCode" - instance invite code in DataHub
Get list of users
Address: /v1/Management/users/GetFilteredPage
Method: POST
Authorization: Required with API Authorization Credentials
Request headers:
Request Parameters work as filter. No parameters are required to get the full list of users.
Response
Quick search for users
Find users by email, phone, name, deviceToken, clientID as a searchterm.
Address: /v1/Management/users/quicksearch
Method: GET
Authorization: Required with API Authorization Credentials
Request headers:
Request
Response
Last updated
Was this helpful?