Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Paragon Permissions API

ReBAC-style access checks over synced objects and subjects.

Paragon Permissions API is one of 10 APIs that Paragon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Permissions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://actionkit.useparagon.com.

5 operations 5 paths 1 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://actionkit.useparagon.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Paragon Permissions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Paragon User Token. A signed JWT token used to authenticate a Connected User.

Paths & Operations 5

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

Permissions 5

ReBAC-style access checks over synced objects and subjects.

POST
/projects/{projectId}/permissions/check-access
Paragon Check Access
checkAccess 1 param body → 200
POST
/projects/{projectId}/permissions/batch-check-access
Paragon Batch Check Access
batchCheckAccess 1 param body → 200
POST
/projects/{projectId}/permissions/list-users
Paragon List Users With Access
listUsers 1 param body → 200
POST
/projects/{projectId}/permissions/list-objects
Paragon List Objects With Access
listObjects 1 param body → 200
POST
/projects/{projectId}/permissions/expand
Paragon Expand Permission Relationships
expandRelationships 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AccessCheck (3 properties). Each schema is shown below with its type and property counts.

AccessCheck
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paragon-permissions-api-openapi.yml Raw ↑

Other APIs Paragon publishes across the network.

Proxy API
Users API
Task History API
Triggers API
Paragon Credentials API
Paragon Custom Integrations API
Paragon Integrations API
Paragon Sync API
Paragon Tools API