GET /v1/auth/permissions

Get account permissions

Responses

  • 200 application/json

    successful operation

    Hide response attribute Show response attribute object
    • permissions array[string] Required

      List of permissions

      Values are login, logout, register, forgot-password, reset-password, check-token, company:public, account:revoke, search:key-create, demo:clear, link:read, link:process, user:action:impersonate, user:list, company:list, company:show, company:update, company:delete, companySettings:create, company:import-data, student:list, student:count, student:birthdays, student:create, student:update, student:delete, student:archive, student:read, staff:list, staff:create, staff:update, staff:delete, staff:read, staff:invite, staff:archive, waiver:list, waiver:create, waiver:update, waiver:delete, waiver:archive, waiver:read, agreement:list, agreement:create, family:list, family:create, family:update, family:archive, family:delete, family:read, family:invite, family:count, family:enable-autopay, family:disable-autopay, location:list, location:create, location:update, location:archive, location:delete, location:read, room:list, room:create, room:update, room:archive, room:delete, room:read, address:list, address:create, address:update, address:delete, address:read, holiday:list, holiday:create, holiday:update, holiday:delete, holiday:read, discount-scheme:list, discount-scheme:create, discount-scheme:update, discount-scheme:delete, discount-scheme:read, custom-field:list, custom-field:create, custom-field:update, custom-field:delete, custom-field:read, custom-field-responses:read, custom-field-responses:update, class:list, class:create, class:update, class:archive, class:delete, class:read, lesson:list, lesson:on-date, attendee:list, season:list, season:create, season:update, season:delete, season:archive, season:read, registration-fee:list, registration-fee:create, registration-fee:update, registration-fee:delete, registration-fee:archive, registration-fee:read, pricing-scheme-value:list, pricing-scheme-value:create, pricing-scheme-value:update, pricing-scheme-value:delete, pricing-scheme-value:read, enrolment:list, enrolment:create, enrolment:update, enrolment:delete, enrolment:read, enrolment:chart:by-month, enrolment:student-count, waitingList:list, waitingList:create, waitingList:delete, lessonAdjustment:list, lessonAdjustment:read, lessonAdjustment:action:additionalLesson, lessonAdjustment:action:changeLessonDate, lessonAdjustment:action:cancelLesson, lessonAdjustment:action:cancelClass, lessonAdjustment:delete, enrolmentAdjustment:list, enrolmentAdjustment:read, enrolmentAdjustment:delete, enrolmentAdjustment:action:makeUpLesson, enrolmentAdjustment:action:cancelEnrolment, enrolmentAdjustment:action:delayedStartEnrolment, attendance:stats, attendance:list, attendance:create, attendance:update, attendance:delete, attendance:read, trial:list, trial:create, trial:update, trial:delete, trial:archive, trial:read, dropIn:list, dropIn:create, dropIn:update, dropIn:delete, dropIn:archive, dropIn:read, makeUpLesson:list, makeUpLesson:create, makeUpLesson:delete, trial:availability:list, message:list, message:save, message:action:send, message:read, message:delete, message:instance-list, avatar:update, avatar:delete, features:read, features:update, feature-flag:set-for-company, contact:list, contact:read, contact:create, contact:update, contact:delete, transaction:list, transaction:delete, transaction:action:createPayment, transaction:action:createCustom, transaction:action:createFromBill, transaction:action:createFromSeason, transaction:chart:by-payment-and-charge, balance:list, balance:retrieve, tax-rate:list, tax-rate:create, tax-rate:read, tax-rate:update, tax-rate:delete, tax-rate:action:makeDefault, bill:read, basket:action:generateQuote, basket:action:checkout, integrations:stripe:action:createOnboardingLink, integrations:stripe:action:createProfileLink, integrations:stripe:action:listPaymentMethods, integrations:stripe:action:deletePaymentMethod, integrations:stripe:action:makeDefaultPaymentMethod, integrations:stripe:action:createSetupIntent, integrations:stripe:action:capturePaymentIntent, integrations:stripe:action:createPaymentSession, integrations:stripe:action:listRefunds, integrations:stripe:action:retrieveRefund, integrations:stripe:action:retrievePaymentIntent, integrations:stripe:action:createRefund, integrations:stripe:action:retrieveAccount, integrations:stripe:action:chargePaymentMethod, payment-link:read, payment-link:action:process, activity-log:list, file:delete, version, transaction:action:create-credit-note, shop:product:list, shop:product:retrieve, shop:product:store, shop:product:category:list, shop:product:category:createOrUpdate, shop:product:category:delete, orders:store, orders:list, order:retrieve, order:update, order:delete, shop:product:archive, or shop:product:restore.

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

GET /v1/auth/permissions
curl \
 --request GET 'https://classmanager.test/v1/auth/permissions'
Response examples (200)
{
  "permissions": [
    "login"
  ]
}
Response examples (403)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}