Document toolboxDocument toolbox

Create JWT REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 01, 2024 by Jason Andrew
2 min read

3.13.0

The Create JWT REST API is used to create a JSON Web Token (JWT) used to access the ServiceMobility system. JWTs are used for all authentication and authorization throughout the system including; access from the mobile application, web management console access, REST API access.


On this page:

Related pages:


Resource URL Summary

Description

POST /createjwt

Supported HTTP Methods

MethodDescription
POST

If the credentials passed in are verified, then this API will return a valid JWT that can then be used to access other REST APIs.

HTTP Headers

HTTP HeaderValue
Content-Typeapplication/json

HTTP Body

This REST API only support the JSON body format.

JSON Format
{
    "username":"",
    "password":""
}

Body Properties

PropertyDescription
usernameA valid user name requesting a JWT
passwordA valid password associated with the above username

HTTP Response

Response Codes

HTTP CodeDescription
200OK. Credentials were verified and a valid JWT was returned.
401Invalid Logon.
500Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause.

Response Body on Success

{
  "token": ""
}

The token property, in the returned response should be used for all subsequent REST API calls.