Authentication

Sign In#

Returns a JSON Web Token (JWT) that can be used to authenticate requests to Ionburst Cloud. An Ionburst Cloud idToken is valid for 60 minutes. An idToken can be obtained by submitting the ionburst_id and ionburst_key, or in the case of an expired token, the ionburst_id and RefreshToken.

URL : /api/signin

Method : POST

Authentication Required : NO

Example Bodies#

Content-Type : application/json

ionburst_id and ionburst_key:

{
    "Username": "IB******************",
    "Password": "eW91aGF2ZXRvb211Y2h0aW1lb255b3VyaGFuZHMh"
}

ionburst_id and RefreshToken:

{
    "Username": "IB******************",
    "RefreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.cont'd"
}

Success Responses#

Condition : Supplied credentials are correct.

Code : 200 OK

Content :

{
  "idToken": "large_string",
  "refreshToken": "large_string"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error