1. Home
  2. Docs
  3. Mavryx API Reference
  4. Scopes

Scopes

In the Mavryx system, scopes are used to determine which microservices an application wants to use, and this is the first level of checking whether a particular microservice/service should be available to the application. At the second level of object availability checking, there are ACL lists.

Scope pattern:

{service_space_name}:{access_level}

or

{service_space_name}:{resource}:{access_level}


You can use * for example me:* grants access to everything inside service/space me.

Space / Service NameDescriptionServices
me:manageEnables editing of personal information.accounts, profile, auth
me:viewAllows browsing of personal information.accounts, profile, auth
auth:manageauth
auth:viewauth
auth:clients:manageauth
auth:clients:viewauth
auth:user:manageauth
auth:user:viewauth

Basic rule:

The first thing checked is whether the token allows access to the resource.

If not, it returns a 401 error.

If yes, then the access mode is checked. If it’s read (GET method), the access level and whether reading/writing is possible are verified. If not, it returns a 401 error.

If the access mode is write (PUT, POST, DELETE), the access level and whether writing is possible are checked. If not, it returns a 401 error.

Next, the system checks the ACL lists. Go here to learn more about how ACL lists work.

Was this article helpful to you? No Yes

How can we help?