Page Comparison

Status

colour	Green
title	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.

ServiceMobility's authentication and authorization system can operate in one of two ways:

As a self contained system, where users authenticate against details stored in ServiceMobility; or
Via integration with a customer's own authentication system. To enable integration, customers need to:
- Provide a REST API in their authentication system which matches the REST Interfaces Authentication REST API Interface; and
- Configure this API's endoint in Entity System Configuration object.

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

On this page:

Table of Contents

maxLevel	12

Related pages:

/wiki/spaces/MOB/pages/3476470

Excerpt

Resource URL Summary

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

Description

POST /createjwt

Supported HTTP Methods

Method	Description
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 Header	Value
Content-Type	application/json

HTTP Body

This REST API only support the JSON body format.

Code Block

language	js
title	JSON Format

{
    "username":"",
    "password":""
}

Body Properties

Property	Description
`username`	A valid user name requesting a JWT
`password`	A valid password associated with the above `username`

HTTP Response

Response Codes

HTTP Code	Description
200	OK. Credentials were verified and a valid JWT was returned.
401	Invalid Logon.
500	Server 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

Code Block

language	js

{
  "token": ""
}

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

Versions Compared

Old Version 4

New Version 5

Key