API Documentation

API Endpoint

Passwords

Passwords

POST /api/v2/passwords
Requestssets reset_password_token and sends email

POST  /api/v2/passwords

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": "passwords",
    "attributes": {
      "email": "test@email.com"
    }
  }
}
Responses204
This response has no content.

Create a password
POST/api/v2/passwords

GET /api/v2/passwords/1
Requestsreturns reset_password_tokenreturns reset_password_tokenreturns error

GET  /api/v2/passwords/1BSSYBsQexdr23MFYZya

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1BSSYBsQexdr23MFYZya",
    "type": "passwords",
    "attributes": {
      "email": "test@email.com",
      "first_password": false
    }
  },
  "meta": {}
}

GET  /api/v2/passwords/1BSSYBsQexdr23MFYZya

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
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "404",
      "code": "record_not_found",
      "title": "Record Not Found",
      "detail": "The requested record was not found",
      "source": {}
    }
  ]
}

GET  /api/v2/passwords/gibberish

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
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "404",
      "code": "record_not_found",
      "title": "Record Not Found",
      "detail": "The requested record was not found",
      "source": {}
    }
  ]
}

Gets a password
GET/api/v2/passwords/{id}

URI Parameters
HideShow
id
number (required) Example: 1

password id

PATCH /api/v2/passwords/1
Requestsupdates password

PATCH  /api/v2/passwords/1BSSYBsQexdr23MFYZya

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": "passwords",
    "attributes": {
      "password": "1BSSYBsQ",
      "password_confirmation": "1BSSYBsQ"
    }
  }
}
Responses204
This response has no content.

Update a password
PATCH/api/v2/passwords/{id}

URI Parameters
HideShow
id
number (required) Example: 1

password id

Generated by aglio on 20 Apr 2024