Skip to main content

Introduction

This component is the only component accessible to apps. All other components of the system (except for a part of View Manager component) will be on a hidden private network. This allows all the other components to communicated with each other with http requests instead of setting up https.

Endpoints​

Auth Service has extensive set of endpoints divided based on their intended use.

Endpoints meant to be used from admin control panel​

  • /admin/api/apps (GET)
  • /admin/api/apps/:appHolderId (GET)
  • /admin/api/registerNewApp (POST)
  • /admin/api/generateOneTimeAssociationToken (POST)
  • /admin/api/permissions/getUnapprovedPermissionsRequests?pageIndex=2&limit=100 (GET)
  • /admin/api/permissions/getUnapprovedPermissionsRequests /:appHolderId (GET)
  • /admin/api/permissions/approvePermissionRequest (PUT)
  • /admin/api/permissions/revokePermission (PUT)
  • /admin/api/views (GET)
  • /admin/api/apps/:appHolderId/views (GET)

Endpoints meant to be used by applications themselves​

  • /app/api/associateWithStorageAppHolder (POST)
  • /app/api/registerNewProfile (POST)
  • /app/api/requestNewPermission (POST)
  • /app/api/checkAccessTokenStatus?accessToken=[token] (GET)
  • /app/api/uploadNewEvents (POST)
  • /app/api/modifyEvent (PUT)
  • /app/api/deleteEvent (DELETE)
  • /app/api/getAllEventsForGivenAccessToken (GET)
  • /app/api/views/registerNewViewInstanceAccess (POST)
  • /app/api/views/runViewInstance (POST)
caution

Registering a new View Template needs to be done manually through View Manager API. Allowing third-party applications to register new View Templates directly could inadvertently open the door to executing malicious code, thereby compromising the system's integrity and potentially leading to a range of unwanted outcomes, from data breaches to unauthorized access or manipulation of system functionalities.

Status info routes​

  • /status_info/checks/check_auth_service_presence (GET)