How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightdash Custom Roles API

The Custom Roles API from Lightdash — 5 operation(s) for custom roles.

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

This API exposes 8 JSON Schema definitions.

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

This API exposes 6 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

6 operations 5 paths 13 schemas 2 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Custom Roles API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 6

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

Custom Roles 6
POST
/api/v2/orgs/{orgUuid}/roles
Create custom role
CreateOrganizationRole 1 param body → 201default
PATCH
/api/v2/orgs/{orgUuid}/roles/{roleUuid}
Update custom role
UpdateOrganizationRole 2 params body → 200default
DELETE
/api/v2/orgs/{orgUuid}/roles/{roleUuid}
Delete custom role
DeleteOrganizationRole 2 params → 200default
GET
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees
List role assignees
GetOrganizationRoleAssignees 2 params → 200default
POST
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopesdeprecated
Add scopes to role
AddScopesToRole 2 params body → 200default
DELETE
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName}deprecated
Remove scope from role
RemoveScopeFromRole 3 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Role (8 properties), RoleAssignee (5 properties), UpdateRole (3 properties), CreateRole (3 properties). Each schema is shown below with its type and property counts.

ApiUnassignRoleFromUserResponse
Role
object
8 properties 8 required
RoleAssignee
object
5 properties 5 required
AddScopesToRole
object
1 property 1 required
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
ApiSuccessEmpty
object
2 properties 1 required
ApiDefaultRoleResponse
object
2 properties 2 required
CreateRole
object
3 properties 1 required
ApiRemoveScopeFromRoleResponse
RoleAssigneeKind
string
UpdateRole
object
3 properties
ApiRoleAssigneesResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-custom-roles-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
Lightdash Feature Flag API
Where this information came from

This is an independent, third-party profile of Lightdash Custom Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.