API examples

A large majority of API calls to work with the Permit API require you to provide the project id and environment id. This quick guide will explain how you can get yours.

To get user permissions, you need to list all the user roles and then fetch all the permissions for each role.

Retrieve relationship tuples that exist inside a specific environment and filter them.

Retrieve role associations that exist inside a specific environment, filtering for specific user, tenant, role, resource or resource instance.

Retrieve users that exist inside a specific environment and filter them by email, key, tenant or role.

Manage Environments in Permit

Tenants are used to group users and roles together. A user can have different roles in multiple tenants.

Often, when creating a new resource, you want to set default actions that can be performed on that resource.

Permit.io API includes bulk APIs for selected operations, which offers a significant performance gains over calling each operation separately.