Scopes

Scopes specify the exact level of access needed, ensuring OAuth tokens are restricted to only the required resources. They do not grant any permissions beyond what the user already has.

Each scope represents a set of resources within our API. The list of resources accessible by the generated OAuth token is strictly limited to the scopes configured in the OAuth application.

How do scopes work

When you create a new OAuth application you will be able to select the scopes you want your app to have access to.

These scopes will be sent through the URL when requesting the authorization code:

https://api.factorialhr.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&redirect_uri=<YOUR_REDIRECT_URI>&response_type=code

Then the client will review the scopes sent though the URL and authorize/deny the app access to these.

Once the user authorizes the app to access the requested scopes, you can continue to request the access token. The access token generated will be restricted to the authorized scopes.

Update OAuth applications scopes (Coming Soon!)

You will be able to update scopes from an existing OAuth application.

NOTE: If you change the scopes in an already existing OAuth app, the already-generated tokens will become outdated so the client will need to re-authorize the app to be able to re-generate the OAuth tokens with the updated scopes list. Once a new token is generated with the new scopes, previous tokens related to that company will be revoked.

Scopes list

Currently, our scopes allow both read and write actions within the resources.