Permissions

Permissions define what resources apps can access on projects / organizations where they are installed.

The permissions for an app are configurable under the "Permissions" tab on an app's dashboard.

Note: we will be adding permissions gradually.

Organizations

organization_info

  • Read

The organization_info permission gives the holder access to organization specific data. It is a required permission for installations. It also allows the holder to read all retirements that the organization holds. Only "Read" is supported currently.

organization_members

  • Read

The organization_members permission gives the holder access to metadata on all stakeholders of an organization. Most importantly the name and email. In future versions this will also include the kyc status of the stakeholder. Only "Read" is supported currently.

organization_warehouse

  • Read

  • Write

The organization_warehouse permission gives the holder access to an organization's warehouse. The "Read" portion gives the holder access to the inventory of the warehouse and reservations made in the warehouse. The "Write" portion allows the holder to reserve credits from the warehouse and then also finish that reservation which moves the credit from the warehouse to some receiver, either as a retirement or the credits themselves.

organization_inventory

  • Read

  • Request

The organization_inventory permission gives the holder access to an organization's inventory of carbon credits. The "Read" portion allows the holder to read all credits from the inventory of the organization and all requests made to that inventory. The "Request" portion allows the holder to request certain actions to be made. For example the holder of a "organization_inventory:request" permission can request the transfer of credits from the inventory to some other address / organization.

organization_projects

  • Read

Currently is not supported but will be.

Users

examiner

  • Read

The examiner permission gives the holder access to some superadmin / protected endpoints.

Last updated