Lightdash

Lightdash Custom Roles API

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

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 10

GET /api/v2/orgs/{orgUuid}/code/roles List custom roles as code #

POST /api/v2/orgs/{orgUuid}/code/roles Upsert custom role as code #

GET /api/v2/orgs/{orgUuid}/roles/code List custom roles as code (deprecated) #

POST /api/v2/orgs/{orgUuid}/roles/code Upsert custom role as code (deprecated) #

POST /api/v2/orgs/{orgUuid}/roles Create custom role #

PATCH /api/v2/orgs/{orgUuid}/roles/{roleUuid} Update custom role #

DELETE /api/v2/orgs/{orgUuid}/roles/{roleUuid} Delete custom role #

GET /api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees List role assignees #

POST /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes Add scopes to role #

DELETE /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName} Remove scope from role #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/lightdash:lightdash-custom-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Lightdash Custom Roles API
  version: 2.616.2
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens'
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Custom Roles
paths:
  /api/v2/orgs/{orgUuid}/code/roles:
    get:
      operationId: GetCodeCustomRoles
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCustomRoleAsCodeListResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get custom roles in code representation
      summary: List custom roles as code
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
    post:
      operationId: UpsertCodeCustomRole
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCustomRoleAsCodeUpsertResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Upsert a custom role from code representation
      summary: Upsert custom role as code
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomRoleAsCode'
  /api/v2/orgs/{orgUuid}/roles/code:
    get:
      operationId: GetCustomRolesAsCode
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCustomRoleAsCodeListResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: List custom roles as code (deprecated)
      tags:
      - Custom Roles
      deprecated: true
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
    post:
      operationId: UpsertCustomRoleAsCode
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCustomRoleAsCodeUpsertResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Upsert custom role as code (deprecated)
      tags:
      - Custom Roles
      deprecated: true
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomRoleAsCode'
  /api/v2/orgs/{orgUuid}/roles:
    post:
      operationId: CreateOrganizationRole
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiDefaultRoleResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create a new role in organization
      summary: Create custom role
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRole'
  /api/v2/orgs/{orgUuid}/roles/{roleUuid}:
    patch:
      operationId: UpdateOrganizationRole
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiDefaultRoleResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update role in organization
      summary: Update custom role
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      - in: path
        name: roleUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRole'
    delete:
      operationId: DeleteOrganizationRole
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete role from organization
      summary: Delete custom role
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      - in: path
        name: roleUuid
        required: true
        schema:
          type: string
  /api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees:
    get:
      operationId: GetOrganizationRoleAssignees
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRoleAssigneesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'List the users, groups, and service accounts currently assigned to a role.

        Used by the delete-confirmation modal to explain why a role cannot

        be deleted while still in use.'
      summary: List role assignees
      tags:
      - Custom Roles
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      - in: path
        name: roleUuid
        required: true
        schema:
          type: string
  /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes:
    post:
      operationId: AddScopesToRole
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Add scopes to role
      tags:
      - Custom Roles
      deprecated: true
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      - in: path
        name: roleUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddScopesToRole'
  /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName}:
    delete:
      operationId: RemoveScopeFromRole
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRemoveScopeFromRoleResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Remove scope from role
      tags:
      - Custom Roles
      deprecated: true
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      - in: path
        name: roleUuid
        required: true
        schema:
          type: string
      - in: path
        name: scopeName
        required: true
        schema:
          type: string
components:
  schemas:
    CreateRole:
      properties:
        scopes:
          items:
            type: string
          type: array
        level:
          $ref: '#/components/schemas/RoleLevel'
        description:
          type: string
        name:
          type: string
      required:
      - name
      type: object
    AnyType:
      description: '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 only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    ApiUnassignRoleFromUserResponse:
      $ref: '#/components/schemas/ApiSuccessEmpty'
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
      required:
      - status
      type: object
    PromotionAction.NO_CHANGES:
      enum:
      - no changes
      type: string
    Role:
      properties:
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        ownerType:
          type: string
          enum:
          - user
          - system
        organizationUuid:
          type:
          - string
          - 'null'
        level:
          $ref: '#/components/schemas/RoleLevel'
        description:
          type:
          - string
          - 'null'
        name:
          type: string
        roleUuid:
          type: string
      required:
      - updatedAt
      - createdAt
      - createdBy
      - ownerType
      - organizationUuid
      - level
      - description
      - name
      - roleUuid
      type: object
    RoleAssigneeKind:
      type: string
      enum:
      - organization_user
      - project_user
      - project_group
      - service_account
    PromotionAction.UPDATE:
      enum:
      - update
      type: string
    PromotionAction.CREATE:
      enum:
      - create
      type: string
    ApiRemoveScopeFromRoleResponse:
      $ref: '#/components/schemas/ApiSuccessEmpty'
    ApiDefaultRoleResponse:
      properties:
        results:
          $ref: '#/components/schemas/Role'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    RoleAssignee:
      properties:
        projectName:
          type:
          - string
          - 'null'
        projectUuid:
          type:
          - string
          - 'null'
        assigneeName:
          type: string
        assigneeId:
          type: string
        kind:
          $ref: '#/components/schemas/RoleAssigneeKind'
      required:
      - projectName
      - projectUuid
      - assigneeName
      - assigneeId
      - kind
      type: object
    ApiRoleAssigneesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/RoleAssignee'
          type: array
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    CustomRoleAsCode:
      properties:
        scopes:
          items:
            type: string
          type: array
        level:
          $ref: '#/components/schemas/RoleLevel'
        description:
          type:
          - string
          - 'null'
        name:
          type: string
        version:
          type: number
          enum:
          - 1
      required:
      - scopes
      - level
      - description
      - name
      - version
      type: object
    ApiCustomRoleAsCodeUpsertResponse:
      properties:
        results:
          properties:
            action:
              anyOf:
              - $ref: '#/components/schemas/PromotionAction.CREATE'
              - $ref: '#/components/schemas/PromotionAction.UPDATE'
              - $ref: '#/components/schemas/PromotionAction.NO_CHANGES'
          required:
          - action
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
    AddScopesToRole:
      properties:
        scopeNames:
          items:
            type: string
          type: array
      required:
      - scopeNames
      type: object
    ApiCustomRoleAsCodeListResponse:
      properties:
        results:
          properties:
            customRoles:
              items:
                $ref: '#/components/schemas/CustomRoleAsCode'
              type: array
          required:
          - customRoles
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    UpdateRole:
      properties:
        scopes:
          properties:
            remove:
              items:
                type: string
              type: array
            add:
              items:
                type: string
              type: array
          required:
          - remove
          - add
          type: object
        description:
          type:
          - string
          - 'null'
        name:
          type: string
      type: object
    RoleLevel:
      type: string
      enum:
      - project
      - organization
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'
x-provenance:
  method: harvested
  publisher: Lightdash
  source: https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

Lightdash Custom Roles API

Operations 10

Documentation

Specifications

Schemas & Data

Other Resources