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

Zesty Roles API

Manage roles and permissions.

Zesty Roles API is one of 25 APIs that Zesty publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

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

This API exposes 5 operations across 2 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://accounts.api.zesty.io/v1.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://accounts.api.zesty.io/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Zesty Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sessionToken).

  • sessionToken — A session token obtained from the Auth API login endpoint.

Paths & Operations 5

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

Roles 5

Manage roles and permissions.

GET
/roles
Zesty List all roles
getRoles → 200401
POST
/roles
Zesty Create a new role
createRole body → 201400401
GET
/roles/{roleZUID}
Zesty Get a role
getRole 1 param → 200401404
PUT
/roles/{roleZUID}
Zesty Update a role
updateRole 1 param body → 200401404
DELETE
/roles/{roleZUID}
Zesty Delete a role
deleteRole 1 param → 200401404

Schemas 1

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

Role
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zesty-roles-api-openapi.yml Raw ↑

Other APIs Zesty publishes across the network.

Zesty Instances API
Zesty Apps API
Zesty Audits API
Zesty Authentication API
Zesty Bins API
Zesty Content Items API
Zesty Content Models API
Zesty Fields API
Zesty Files API
Zesty Groups API
Zesty Head Tags API
Zesty Navigation API