Permit.io

Permit.io integration (Developer Tools, Security). Imported from open-connector.

API key13 toolshttps://api.permit.io

GET

permit_io_list_users

List users in a Permit.io environment.

/users

6 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
search	string	optional	Text to search for in user email addresses.
role	string	optional	Only return users assigned this role id or key.
page	integer	optional	The page number to retrieve, starting at 1.
perPage	integer	optional	The maximum number of records per page.

GET

permit_io_get_user

Retrieve a Permit.io user by id or key.

/users/{userId}

3 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
userId	string	required	The Permit.io user id or key.

POST

permit_io_create_user

Create a user in a Permit.io environment.

/users

7 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
key	string	required	The unique key Permit.io uses to identify the user.
email	string	optional	The user's email address.
first_name	string	optional	The user's first name.
last_name	string	optional	The user's last name.
attributes	object	optional	Arbitrary user attributes used by attribute-based policies.

PATCH

permit_io_update_user

Partially update a Permit.io user.

/users/{userId}

7 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
userId	string	required	The Permit.io user id or key.
email	string	optional	The user's email address.
first_name	string	optional	The user's first name.
last_name	string	optional	The user's last name.
attributes	object	optional	Arbitrary user attributes used by attribute-based policies.

DELETE

permit_io_delete_user

Delete a Permit.io user by id or key.

/users/{userId}

3 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
userId	string	required	The Permit.io user id or key.

GET

permit_io_list_tenants

List tenants in a Permit.io environment.

/tenants

5 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
search	string	optional	Text to search for in tenant names or keys.
page	integer	optional	The page number to retrieve, starting at 1.
perPage	integer	optional	The maximum number of records per page.

GET

permit_io_get_tenant

Retrieve a Permit.io tenant by id or key.

/tenants/{tenantId}

3 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
tenantId	string	required	The Permit.io tenant id or key.

POST

permit_io_create_tenant

Create a tenant in a Permit.io environment.

/tenants

6 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
key	string	required	The URL-friendly key Permit.io uses to identify the tenant.
name	string	required	The descriptive tenant name.
description	string	optional	The longer tenant description.
attributes	object	optional	Arbitrary tenant attributes used by attribute-based policies.

PATCH

permit_io_update_tenant

Partially update a Permit.io tenant.

/tenants/{tenantId}

6 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
tenantId	string	required	The Permit.io tenant id or key.
name	string	optional	The descriptive tenant name.
description	string	optional	The longer tenant description.
attributes	object	optional	Arbitrary tenant attributes used by attribute-based policies.

DELETE

permit_io_delete_tenant

Delete a Permit.io tenant by id or key.

/tenants/{tenantId}

3 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
tenantId	string	required	The Permit.io tenant id or key.

GET

permit_io_list_role_assignments

List role assignments in a Permit.io environment.

/role_assignments

10 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
user	string	optional	Only return assignments for this user id or key.
role	string	optional	Only return assignments granting this role id or key.
tenant	string	optional	Only return assignments in this tenant id or key.
resource	string	optional	Only return assignments for this resource type.
resourceInstance	string	optional	Only return assignments for this resource instance.
detailed	boolean	optional	Whether to include full user, tenant, and role details.
page	integer	optional	The page number to retrieve, starting at 1.
perPage	integer	optional	The maximum number of records per page.

POST

permit_io_assign_role

Assign a Permit.io role to a user.

/role_assignments

6 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
user	string	required	The user id or key receiving the role.
role	string	required	The role id or key to assign or remove.
tenant	string	optional	The tenant id or key that scopes the role.
resource_instance	string	optional	The resource instance id, or resource_type:resource_instance key, that scopes t…

DELETE

permit_io_unassign_role

Remove a Permit.io role assignment from a user.

/role_assignments

6 parameters

Param	Type	Required	Description
projectId	string	optional	The Permit.io project id or key. Required when the connected API key is not env…
environmentId	string	optional	The Permit.io environment id or key. Required when the connected API key is not…
user	string	required	The user id or key receiving the role.
role	string	required	The role id or key to assign or remove.
tenant	string	optional	The tenant id or key that scopes the role.
resource_instance	string	optional	The resource instance id, or resource_type:resource_instance key, that scopes t…