Authenticate

Authenticate Documentation

Authenticate [POST]

Authenticate [POST]

Request

Endpoint

POST /api/v2/user/authenticate
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "authenticate",
    "attributes": {
      "cas_ticket": "ST-314971-9fjrd0HfOINCehJ5TKXX-cas2a"
    }
  }
}

Parameters

Attributes

cas_ticket

Type string

Description A valid CAS Ticket from The Key

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "user::authenticate",
    "type": "authenticate",
    "attributes": {
      "created_at": "2021-11-23T14:38:24Z",
      "json_web_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNjU4OGViNzUtZDhmZS00NzYyLTkwYTgtOTAzNzJhMTI1NTg3IiwiZXhwIjoxNjQwMjcwMzA0fQ.12pueC7xrRwzPTj4gvL5AEr3rMqd8bMLpQhNgRF5rFQ",
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

json_web_token

Type string

Description JSON Web Token

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.