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 Users API

Users represent human end-users of your applications that you'd like to enforce permissions on.You must create a user object in Permit.io prior to trying to enforce permissions for that user.A user is identified by its key, and you can only create one user with the same key inside a Permit environment.You can place users within tenants via role assignments in order to enforce multi-tenancy in your app.You may create users via the API (shown below), with one of the SDKs, or via the Permit cloud console.

Permit.io Users 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.permit.io.

8 operations 3 paths 14 schemas 2 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Permit.io Users 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 8

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

Users 8

Users represent human end-users of your applications that you'd like to enforce permissions on. You must create a user object in Permit.io prior to trying to enforce permissions f…

GET
/v2/facts/{proj_id}/{env_id}/users
List Users
list_users 8 params → 200422
POST
/v2/facts/{proj_id}/{env_id}/users
Create User
create_user 2 params body → 200422
GET
/v2/facts/{proj_id}/{env_id}/users/{user_id}
Get User
get_user 3 params → 200422
PUT
/v2/facts/{proj_id}/{env_id}/users/{user_id}
Replace User
replace_user 3 params body → 200201422
DELETE
/v2/facts/{proj_id}/{env_id}/users/{user_id}
Delete User
delete_user 3 params → 204422
PATCH
/v2/facts/{proj_id}/{env_id}/users/{user_id}
Update User
update_user 3 params body → 200422
POST
/v2/facts/{proj_id}/{env_id}/users/{user_id}/roles
Assign Role To User
assign_role_to_user 3 params body → 200422
DELETE
/v2/facts/{proj_id}/{env_id}/users/{user_id}/roles
Unassign Role From User
unassign_role_from_user 4 params body → 200204404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are UserRead (13 properties), RoleAssignmentRead (13 properties), UserCreate (6 properties), UserInTenant (4 properties). Each schema is shown below with its type and property counts.

UserCreate
object
6 properties 1 required
UserRoleRemove
object
3 properties 2 required
PaginatedResult_UserRead_
object
3 properties 2 required
UserRead
object
13 properties 7 required
HTTPValidationError
object
1 property
UserRoleCreate
object
3 properties 1 required
UserRole
object
2 properties 2 required
RoleAssignmentRead
object
13 properties 10 required
UserInTenant
object
4 properties 3 required
UserUpdate
object
4 properties
UserStatus
string
An enumeration.
UserResourceInstanceRole
object
3 properties 3 required
SearchOperator
string
An enumeration.
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

permit-io-users-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 Users 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.