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

Unkey permissions API

Permission and role management operations

Unkey permissions API is one of 8 APIs that Unkey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Permissions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

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

Requests are made against a single base URL, https://api.unkey.com.

8 operations 8 paths 35 schemas 8 POST

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.unkey.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Unkey permissions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (root key) (rootKey). By default, every request must be authenticated.

  • rootKey — Unkey uses API keys (root keys) for authentication. These keys authorize access to management operations in the API. To authenticate, include your root key in…

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

permissions 8

Permission and role management operations

POST
/v2/permissions.createPermission
Create Permission
permissions.createPermission body → 200400401403409429500
POST
/v2/permissions.createRole
Create Role
permissions.createRole body → 200400401403409429500
POST
/v2/permissions.deletePermission
Delete Permission
permissions.deletePermission body → 200400401403404429500
POST
/v2/permissions.deleteRole
Delete Role
permissions.deleteRole body → 200400401403429500
POST
/v2/permissions.getPermission
Get Permission
permissions.getPermission body → 200400401403404429500
POST
/v2/permissions.getRole
Get Role
permissions.getRole body → 200400401403404429500
POST
/v2/permissions.listPermissions
List Permissions
permissions.listPermissions body → 200400401403429500
POST
/v2/permissions.listRoles
List Roles
permissions.listRoles body → 200400401403404429500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Role (4 properties), Permission (4 properties), BaseError (4 properties), V2PermissionsListRolesResponseBody (3 properties). Each schema is shown below with its type and property counts.

V2PermissionsDeleteRoleRequestBody
object
1 property 1 required
V2PermissionsListRolesRequestBody
object
2 properties
V2PermissionsDeletePermissionResponseBody
object
2 properties 2 required
ValidationError
object
Individual validation error details. Each validation error provides precise information about what failed, where it failed, and how to fix it, enabling efficie…
3 properties 2 required
Meta
object
Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. Th…
1 property 1 required
BadRequestErrorDetails
Extended error details specifically for bad request (400) errors. This builds on the BaseError structure by adding an array of individual validation errors, ma…
NotFoundErrorResponse
object
Error response when the requested resource cannot be found. This occurs when: - The specified resource ID doesn't exist in your workspace - The resource has be…
2 properties 2 required
UnauthorizedErrorResponse
object
Error response when authentication has failed or credentials are missing. This occurs when: - No authentication token is provided in the request - The provided…
2 properties 2 required
V2PermissionsListRolesResponseData
array
Array of roles with their assigned permissions.
V2PermissionsGetPermissionRequestBody
object
1 property 1 required
V2PermissionsCreateRoleResponseData
object
1 property 1 required
Pagination
object
Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
2 properties 1 required
V2PermissionsGetPermissionResponseBody
object
2 properties 2 required
V2PermissionsCreateRoleRequestBody
object
2 properties 1 required
V2PermissionsCreatePermissionResponseData
object
1 property 1 required
TooManyRequestsErrorResponse
object
Error response when the client has sent too many requests in a given time period. This occurs when you've exceeded a rate limit or quota for the resource you'r…
2 properties 2 required
V2PermissionsGetRoleRequestBody
object
1 property 1 required
V2PermissionsDeleteRoleResponseBody
object
2 properties 2 required
V2PermissionsListPermissionsResponseData
array
Array of permission objects with complete configuration details.
V2PermissionsListRolesResponseBody
object
3 properties 2 required
V2PermissionsDeletePermissionRequestBody
object
1 property 1 required
V2PermissionsCreatePermissionRequestBody
object
3 properties 2 required
V2PermissionsGetRoleResponseBody
object
2 properties 2 required
BadRequestErrorResponse
object
Error response for invalid requests that cannot be processed due to client-side errors. This typically occurs when request parameters are missing, malformed, o…
2 properties 2 required
Permission
object
4 properties 3 required
Role
object
4 properties 2 required
V2PermissionsCreatePermissionResponseBody
object
2 properties 2 required
ConflictErrorResponse
object
Error response when the request conflicts with the current state of the resource. This occurs when: - Attempting to create a resource that already exists - Mod…
2 properties 2 required
ForbiddenErrorResponse
object
Error response when the provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when: - The root key doesn't ha…
2 properties 2 required
V2PermissionsListPermissionsResponseBody
object
3 properties 2 required
InternalServerErrorResponse
object
Error response when an unexpected error occurs on the server. This indicates a problem with Unkey's systems rather than your request. When you encounter this e…
2 properties 2 required
V2PermissionsCreateRoleResponseBody
object
2 properties 2 required
BaseError
object
Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP r…
4 properties 4 required
V2PermissionsListPermissionsRequestBody
object
2 properties
EmptyResponse
object
Empty response object by design. A successful response indicates this operation was successfully executed.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unkey-permissions-api-openapi.yml Raw ↑

Other APIs Unkey publishes across the network.

Unkey analytics API
Unkey apis API
Unkey deploy API
Unkey identities API
Unkey keys API
Unkey liveness API
Unkey ratelimit API
Where this information came from

This is an independent, third-party profile of Unkey permissions 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.