How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Permit.io Groups API

The Groups API from Permit.io — 10 operation(s) for groups.

Permit.io Groups API is one of 43 APIs that Permit.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 10 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against the base URL https://api.permit.io.

16 operations 10 paths 14 schemas 4 DELETE8 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.permit.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Permit.io Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (HTTPBearer).

  • HTTPBearer — Authorization header, we support the bearer authentication scheme (see: RFC 6750)

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 4 DELETE, 8 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 16
GET
/v2/schema/{proj_id}/{env_id}/groups/direct
List Direct Group
list_direct_group 7 params → 200422
GET
/v2/schema/{proj_id}/{env_id}/groups/direct/{group_instance_key}
Get Direct Group
get_direct_group 3 params → 200422
GET
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/children
List group children (EAP)
list_group_children 5 params → 200422
GET
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/parents
List group parents (EAP)
list_group_parents 5 params → 200422
GET
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users
List group users (EAP)
list_group_users 5 params → 200422
GET
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/roles
List group roles (EAP)
list_group_roles 5 params → 200422
POST
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/roles
Assign Role To Group
assign_role_to_group 3 params body → 200422
DELETE
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/roles
Remove Role From Group
remove_role_from_group 3 params body → 204422
GET
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}deprecated
Get Group
get_group 3 params → 200422
DELETE
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}
Delete Group
delete_group 3 params → 204422
GET
/v2/schema/{proj_id}/{env_id}/groupsdeprecated
List Group
list_group 8 params → 200422
POST
/v2/schema/{proj_id}/{env_id}/groups
Create Group
create_group 2 params body → 200422
PUT
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users/{user_id}
Assign User To Group
assign_user_to_group 4 params body → 200422
DELETE
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users/{user_id}
Remove User From Group
remove_user_from_group 4 params body → 204422
PUT
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/assign_group
Assign Group To Group
assign_group_to_group 3 params body → 200422
DELETE
/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/assign_group
Remove Group From Group
remove_group_from_group 3 params body → 204422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GroupRead (5 properties), GroupAddRole (4 properties), GroupReadSchema (4 properties), PaginatedResult_GroupReadSchema_ (3 properties). Each schema is shown below with its type and property counts.

GroupUserReadSchema
object
2 properties 2 required
PaginatedResult_GroupRoleReadSchema_
object
3 properties 2 required
GroupAssignment
object
1 property 1 required
GroupRead
object
5 properties 2 required
HTTPValidationError
object
1 property
GroupCreate
object
3 properties 2 required
ValidationError
object
3 properties 3 required
GroupReadSchema
object
4 properties 3 required
GroupAddRole
object
4 properties 4 required
PaginatedResult_GroupUserReadSchema_
object
3 properties 2 required
GroupRoleResourceReadOnly
object
2 properties 2 required
PaginatedResult_GroupReadSchema_
object
3 properties 2 required
GroupAssignUser
object
1 property 1 required
GroupRoleReadSchema
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

permit-io-groups-api-openapi.yml Raw ↑

Other APIs Permit.io publishes across the network.

Permit.io Access Requests (EAP) API
Permit.io Activity Log API
Permit.io API History API
Permit.io API Keys API
Permit.io Audit Elements Data API
Permit.io Audit Log Replay API
Permit.io Audit Logs API
Permit.io Bulk Operations API
Permit.io Condition Set Rules API
Permit.io Condition Sets API
Permit.io Deprecated API
Permit.io Elements Configs (EAP) API
Where this information came from

This is an independent, third-party profile of Permit.io Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.