When a user installs your app, they will be assigned an account on the user data hub, and given the necessary credentials to access the API: a Device Token, a JTW Access Token, and a Refresh Token.
Required level of authorization:
- Admin level - to get any user device status
When to use this call
When a user installs your app, they will need to have an associated account on the user data hub. You create that account with this call, and receive the user credentials in return.
Things to keep in mind
Note that the API does not qualify the user fields at all, and in fact, all fields can be empty. The only user specific data is then the device token. If you have certain requirements for some fields (first name must be at least two letters, email domain must be mycompany.com, etc.) do an input validation in your app before sending these fields to the API.
If your app is "private", for example a company fleet app, you can work with an invitation code. In that case, you need to first execute the API call for the invitation code, and only if the call passes, you should call this method to actually add the user.