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

Keyper Permissions API

Retrieve the permission whitelist / blacklist for an Access Control System.

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

Tagged areas include Permissions. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://api.keyper.io/access, https://sandbox.api.keyper.io/access.

1 operations 1 paths 7 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.keyper.io/access
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Keyper Permissions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (keyperAuth).

  • keyperAuth — Authorization header carrying either an app secret ("APPSECRET ") or a user authentication token ("AUTHTOKEN ").

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Permissions 1

Retrieve the permission whitelist / blacklist for an Access Control System.

GET
/v1/permissions
Get permissions (Whitelist / Blacklist)
getPermissions 6 params → 200401422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Metadata (6 properties), Permission (6 properties), ErrorResponse (4 properties), ErrorListItem (3 properties). Each schema is shown below with its type and property counts.

Permission
object
6 properties 4 required
ErrorResponse
object
keyper error envelope.
4 properties
ActionMessage
object
2 properties 1 required
PermissionResponseModel
object
2 properties 1 required
ErrorListItem
object
3 properties
PermissionActionEnum
string
Action the access control system should perform.
Metadata
object
Additional ticket data about the permission.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keyper-permissions-api-openapi.yml Raw ↑

Other APIs Keyper publishes across the network.

Keyper Transactions API