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

Acceldata Roles API

Manage roles and permissions

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

This API exposes 28 JSON Schema definitions.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 28 JSON Schemas.

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

Requests are made against a single base URL, https://api.acceldata.app/v1.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.acceldata.app/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Acceldata Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

  • apiKey — Acceldata API key for authentication

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.

Roles 1

Manage roles and permissions

GET
/roles
Acceldata List Roles
listRoles → 200401

Schemas 3

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

RoleList
object
Paginated list of roles
4 properties
ErrorResponse
object
Error response
3 properties
Role
object
A role with associated permissions
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acceldata-roles-api-openapi.yml Raw ↑

Other APIs Acceldata publishes across the network.

Acceldata Alerts API
Acceldata Data Quality Rules API
Acceldata Datasets API
Acceldata Lineage API
Acceldata Pipeline Jobs API
Acceldata Users API