API Documentation
Sessions ¶
Sessions ¶
GET /api/v2/sessions
Requests
GET /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "55",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 135,
"token": "d0ed39f6-0ddc-4993-ad3c-2b64bf6cbb68",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2024-04-18T06:02:03.470+02:00",
"token_expires_at": null,
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/sessions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/sessions?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get all sessionsGET/api/v2/sessions
DELETE /api/v2/sessions/1
Requests
DELETE /api/v2/sessions/57
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
POST /api/v2/sessions/machine
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"name": "test token",
"read_only": true
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "65",
"type": "sessions",
"attributes": {
"name": "test token",
"note": null,
"user_id": 139,
"token": "57187334-43dc-470c-ab14-ccebfa0cb941",
"last_ip": "127.0.0.1",
"location": "",
"device": null,
"platform": null,
"browser": "Mozilla",
"machine": true,
"read_only": true,
"last_activity_at": "2024-04-18T06:02:03.748+02:00",
"token_expires_at": null,
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/sessions/machine
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
POST /api/v2/sessions/jwt?expires_in=60
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/json; charset=utf-8
Body
{
"jwt": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDUsImV4cCI6MTcxMzQxMjk4NCwidHlwZSI6InJlYWQtb25seSJ9.OANx88c62PgZMoiOGX9wuoqnT-2qPPZqH8lvNwU3U88",
"payload": {
"user_id": 145,
"exp": 1713412984,
"type": "read-only"
}
}
POST /api/v2/sessions
Requests
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login@email.com",
"password": "123123"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2153",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7443,
"token": "49426e16-adbb-4db6-b3cb-1d1bb365fdf0",
"last_ip": "127.0.0.1",
"location": "",
"device": null,
"platform": null,
"browser": "Mozilla",
"machine": false,
"read_only": false,
"last_activity_at": "2024-04-18T06:15:09.548+02:00",
"token_expires_at": "2024-05-02T06:15:09.548+02:00",
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login@email.com",
"password": "aaa"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login+invalid@email.com",
"password": "123123"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
Create a sessionPOST/api/v2/sessions
URI Parameters
string
(required) Example: user%40mail.comemail
- password
string
(required) Example: 123password
PUT /api/v2/sessions/1/validate_otp
Requests
PUT /api/v2/sessions/2156/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "277453",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7449"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2156",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7449,
"token": "60a331e5-cad9-47da-850b-a0eb78217ea1",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2024-04-18T06:15:09.983+02:00",
"token_expires_at": null,
"two_factor_auth": true,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PUT /api/v2/sessions/2158/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "abcdefgh",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7451"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2158",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7451,
"token": "3d65acb4-2bf1-4fda-b7f5-57cbc308ec7c",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2024-04-18T06:15:10.163+02:00",
"token_expires_at": null,
"two_factor_auth": true,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PUT /api/v2/sessions/2160/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "277453",
"password": "000000"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7453"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
PUT /api/v2/sessions/2162/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "000000",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7455"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/otp"
}
}
]
}
PUT /api/v2/sessions/2164/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "abcdefgh",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7457"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"code": "validation_time_expired",
"title": "Access Denied",
"detail": "You are not authorized to access this resource",
"source": {}
}
]
}
Validates s sessionPUT/api/v2/sessions/{id}/validate_otp
URI Parameters
- id
number
(required) Example: 1session id
- password
string
(required) Example: 123password
- otp
string
(required) Example: abcotp
- user_id: `1` (number, required) - user_id
string
(required)
Generated by aglio on 18 Apr 2024