Scopes

Scope is a mechanism in OAuth 2.0 to limit an application's access to a user's account. An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted.

Mandatory scope:

  • offline_access                                      Mandatory to get the refresh_token

List of optional scopes:

  • employee.employment                     View and manage employment data: contracts, salary, schedule

  • employee.employment.read           View employment data: contracts, salary, schedule

  • employee.info                                      View and manage employee information: personal info, bank account, address, family data

  • employee.info.read                            View employee information: personal info, bank account, address, family data 

  • employee.payment                            View and manage payment data: hour components

  • employee.payment.read                  View payment data: hour components

  • company.info                                       View and manage company information

  • company.info.read                             View company information

  • company.payrollsettings.read        View payroll settings: hour codes