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

Warrant Roles and Permissions API

RBAC and entitlements convenience surface (roles, permissions, users, tenants, features, pricing tiers).

Warrant Roles and Permissions API is one of 5 APIs that Warrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 14 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.warrant.dev, http://localhost:8000.

14 operations 7 paths 6 schemas 1 DELETE6 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.warrant.dev/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Warrant Roles and Permissions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key passed as Authorization: ApiKey YOURAPIKEY. Self-hosted deployments configure the key via ApiKey in the server config.

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 1 DELETE, 6 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Roles and Permissions 14

RBAC and entitlements convenience surface (roles, permissions, users, tenants, features, pricing tiers).

GET
/v1/roles
List roles
listRoles → 200
POST
/v1/roles
Create a role
createRole body → 200
POST
/v1/roles/{roleId}/permissions/{permissionId}
Assign a permission to a role
assignPermissionToRole 2 params → 200
DELETE
/v1/roles/{roleId}/permissions/{permissionId}
Remove a permission from a role
removePermissionFromRole 2 params → 200
GET
/v1/permissions
List permissions
listPermissions → 200
POST
/v1/permissions
Create a permission
createPermission body → 200
GET
/v1/users
List users
listUsers → 200
POST
/v1/users
Create a user
createUser body → 200
GET
/v1/tenants
List tenants
listTenants → 200
POST
/v1/tenants
Create a tenant
createTenant body → 200
GET
/v1/features
List features
listFeatures → 200
POST
/v1/features
Create a feature
createFeature body → 200
GET
/v1/pricing-tiers
List pricing tiers
listPricingTiers → 200
POST
/v1/pricing-tiers
Create a pricing tier
createPricingTier body → 200

Schemas 6

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

Object
object
4 properties
Role
object
3 properties
PricingTier
object
3 properties
Permission
object
3 properties
Feature
object
3 properties
ObjectCreate
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

warrant-dev-roles-and-permissions-api-openapi.yml Raw ↑

Other APIs Warrant publishes across the network.

Warrant Check API
Warrant Object Types API
Warrant Objects API
Warrant Warrants API