Dashboard API explorer

/api/administrator/reset-code (PATCH)

Account information like email addresses is generated with faker-js it is not real user information.

await global.api.administrator.ResetCode.patch(req)

Returns object

{
  "codeid": "code_2d2f6450ebe7001d",
  "object": "resetCode",
  "appid": "tests_1656038570",
  "accountid": "acct_1ef8c43e87e87a12",
  "createdAt": "2022-06-24T02:42:50.216Z",
  "updatedAt": "2022-06-24T02:42:50.216Z"
}

Exceptions

These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:

Exception Circumstances
invalid-reset-codeid missing querystring codeid
invalid querystring codeid

NodeJS source (view on github)

const dashboard = require('../../../../index.js')

module.exports = {
  get: async (req) => {
    if (!req.query || !req.query.codeid) {
      throw new Error('invalid-reset-codeid')
    }
    let code = await dashboard.StorageCache.get(req.query.codeid)
    if (!code) {
      let codeInfo
      try {
        codeInfo = await dashboard.Storage.ResetCode.findOne({
          where: {
            codeid: req.query.codeid,
            appid: req.appid || global.appid
          }
        })
      } catch (error) {
      }
      if (!codeInfo) {
        throw new Error('invalid-reset-codeid')
      }
      code = {}
      for (const field of codeInfo._options.attributes) {
        code[field] = codeInfo.get(field)
      }
      await dashboard.StorageCache.set(req.query.codeid, code)
    }
    delete (code.secretCodeHash)
    return code
  }
}

Test source (view on github)

/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../test-helper.js')

describe('/api/administrator/reset-code', () => {
  describe('exceptions', () => {
    describe('invalid-reset-codeid', () => {
      it('missing querystring codeid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/reset-code')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-reset-codeid')
      })

      it('invalid querystring codeid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/reset-code?codeid=invalid')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-reset-codeid')
      })
    })
  })

  describe('returns', () => {
    it('object', async () => {
      const administrator = await TestHelper.createOwner()
      const user = await TestHelper.createUser()
      await TestHelper.createResetCode(user)
      const req = TestHelper.createRequest(`/api/administrator/reset-code?codeid=${user.resetCode.codeid}`)
      req.account = administrator.account
      req.session = administrator.session
      const codeNow = await req.get()
      assert.strictEqual(codeNow.accountid, user.account.accountid)
    })
  })

  describe('redacts', () => {
    it('secretCodeHash', async () => {
      const administrator = await TestHelper.createOwner()
      const user = await TestHelper.createUser()
      await TestHelper.createResetCode(user)
      const req = TestHelper.createRequest(`/api/administrator/reset-code?codeid=${user.resetCode.codeid}`)
      req.account = administrator.account
      req.session = administrator.session
      req.filename = __filename
      req.saveResponse = true
      const codeNow = await req.get()
      assert.strictEqual(codeNow.accountid, user.account.accountid)
      assert.strictEqual(undefined, codeNow.secretCodeHash)
    })
  })
})