Auth API

GET /auth/bootstrap-status

Get Initial Setup Status

Return whether initial Celerp setup has been completed, allowing clients to choose between first-time registration and the normal sign-in flow.

Responses

Example

curl -X GET http://localhost:8000/auth/bootstrap-status \
  -H "Authorization: Bearer $TOKEN"

POST /auth/change-password

Change User Password

Change the password for the authenticated Celerp user after validating the supplied current password.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/change-password \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /auth/firm-view

Firm View

Every company the user can open, with its accountant sync, last sync and what needs attention, newest activity first; ``q`` searches names, ``sync`` filters.

Parameters

Responses

Example

curl -X GET http://localhost:8000/auth/firm-view \
  -H "Authorization: Bearer $TOKEN"

POST /auth/login

Log In

Authenticate a Celerp user.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/login \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/login-force

Log In and Replace Existing Sessions

Authenticate a Celerp user while replacing the user's other active sessions, then return the new session information.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/login-force \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/logout

Log Out

End the caller's current Celerp authentication session.

Request body

LogoutRequest, optional

Responses

Example

curl -X POST http://localhost:8000/auth/logout \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /auth/my-companies

List Accessible Companies

Return the companies the authenticated user can access, including the information needed to choose an active company.

Responses

Example

curl -X GET http://localhost:8000/auth/my-companies \
  -H "Authorization: Bearer $TOKEN"

POST /auth/password-recovery/reset

Recovery Reset

Reset the password of the user whose email this is, when the relay confirms the code it emailed them for the requester's recovery. A handle that holds no live recovery of this email has no right code and never reaches the relay.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/password-recovery/reset \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/password-recovery/send

Recovery Send

Email a recovery code to the user whose email this is, if there is one here, and answer the handle the requester holds this recovery by, alike for any address. "unavailable" says no code is coming: the relay is down, or it could not deliver it. "undeliverable" says the relay never mails such an address, for any address alike.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/password-recovery/send \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /auth/password-recovery/terminal

Recovery Terminal

The terminal reset command, for the person at this computer only: it names this computer's folders.

Responses

Example

curl -X GET http://localhost:8000/auth/password-recovery/terminal \
  -H "Authorization: Bearer $TOKEN"

GET /auth/password-reset-notices

Reset Notices

The password resets the caller has not acknowledged yet, newest first, timed in the company's timezone. ``own`` marks a reset of the caller's own password. Reading them changes nothing: each stays until it is acknowledged.

Responses

Example

curl -X GET http://localhost:8000/auth/password-reset-notices \
  -H "Authorization: Bearer $TOKEN"

POST /auth/password-reset-notices/acknowledge

Acknowledge Reset Notices

The caller has seen these resets: their notices are gone. Ids already acknowledged, or not the caller's, change nothing.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/password-reset-notices/acknowledge \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/register

Register First Administrator

Create the first Celerp administrator and company during initial setup. Registration is available only before the installation has been bootstrapped.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/register \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/start-company

Start a Company After a Reset

Create a company for a login that has none left, which happens after its last company was reset, and sign in as that company's owner. The request carries the login's email and password and the new company's name.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/start-company \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /auth/switch-company/{company_id}

Switch Active Company

Switch the authenticated user's active company to another company they can access.

Parameters

Responses

Example

curl -X POST http://localhost:8000/auth/switch-company/:company_id \
  -H "Authorization: Bearer $TOKEN"

POST /auth/token/refresh

Refresh Authentication Session

Refresh the authenticated Celerp session.

Request body

Responses

Example

curl -X POST http://localhost:8000/auth/token/refresh \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'