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 SCIM API

The SCIM API from Lightdash — 12 operation(s) for scim.

Lightdash SCIM 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 SCIM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 20 operations across 12 paths, and defines 32 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

20 operations 12 paths 32 schemas 2 DELETE12 GET2 PATCH2 POST2 PUT

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 SCIM 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 20

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

SCIM 20
GET
/api/v1/scim/v2/Users
List users
GetScimUsers 3 params → 200
POST
/api/v1/scim/v2/Users
Create user
CreateScimUser body → 200201400409
GET
/api/v1/scim/v2/Users/{userUuid}
Get user
GetScimUser 1 param → 200404
PUT
/api/v1/scim/v2/Users/{userUuid}
Replace user
UpdateScimUser 1 param body → 200400404
PATCH
/api/v1/scim/v2/Users/{userUuid}
Patch user
PatchScimUser 1 param body → 200400404
DELETE
/api/v1/scim/v2/Users/{userUuid}
Delete user
DeleteScimUser 1 param → 204404
GET
/api/v1/scim/v2
Root check
GetScimRoot → 200204
GET
/api/v1/scim/v2/ServiceProviderConfig
Provider config
GetScimServiceProviderConfig → 200
GET
/api/v1/scim/v2/Schemas
List schemas
GetScimSchemas → 200
GET
/api/v1/scim/v2/Schemas/{schemaId}
Get schema
GetScimSchema 1 param → 200
GET
/api/v1/scim/v2/ResourceTypes
List resource types
GetScimResourceTypes → 200
GET
/api/v1/scim/v2/ResourceTypes/{resourceTypeId}
Get resource type
GetScimResourceType 1 param → 200
GET
/api/v1/scim/v2/Roles
List roles
GetScimRoles 3 params → 200
GET
/api/v1/scim/v2/Roles/{roleId}
Get role
GetScimRole 1 param → 200404
GET
/api/v1/scim/v2/Groups
List groups
GetScimGroups 3 params → 200
POST
/api/v1/scim/v2/Groups
Create group
CreateScimGroup body → 200201400409
GET
/api/v1/scim/v2/Groups/{id}
Get group
GetScimGroup 1 param → 200404
PATCH
/api/v1/scim/v2/Groups/{id}
Patch group
UpdateScimGroup 1 param body → 200204400404
PUT
/api/v1/scim/v2/Groups/{id}
Replace group
ReplaceScimGroup 1 param body → 200204400404
DELETE
/api/v1/scim/v2/Groups/{id}
Delete group
DeleteScimGroup 1 param → 204404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ScimSchemaAttribute (11 properties), ScimServiceProviderConfig (9 properties), ScimUser (9 properties), ScimResourceType (8 properties). Each schema is shown below with its type and property counts.

ScimSchemaType.RESOURCE_TYPE
string
ScimSchemaType.SERVICE_PROVIDER_CONFIG
string
ScimPatchRemoveOperation
object
3 properties 2 required
ScimPatchAddReplaceOperation
object
3 properties 1 required
ScimSchemaType.SCHEMA
string
ScimSchemaType.ERROR
string
Pick_ScimUser.Exclude_keyofScimUser.id__
object
From T, pick a set of properties whose keys are in the union K
8 properties 2 required
ScimGroupMember
object
2 properties 1 required
ScimListResponse_ScimResourceType_
object
5 properties 5 required
ScimUpsertGroup
object
3 properties 2 required
LightdashScimExtension
object
1 property
ScimUserRole
object
4 properties 1 required
ScimSchemaAttribute
object
11 properties 8 required
ScimErrorPayload
object
4 properties 3 required
ScimPatchSchema
string
ScimUpsertUser
ScimServiceProviderConfig
object
9 properties 8 required
ScimResourceType
object
8 properties 5 required
ScimListResponse_ScimUser_
object
5 properties 5 required
ScimSchema
object
6 properties 3 required
ScimGroup
object
5 properties 4 required
ScimRole
object
7 properties 5 required
ScimPatch
object
2 properties 2 required
ScimListResponse_ScimRole_
object
5 properties 5 required
ScimListResponse_ScimGroup_
object
5 properties 5 required
ScimSchemaType.ROLE
string
ScimPatchOperation
ScimListResponse_ScimSchema_
object
5 properties 5 required
Omit_ScimUser.id_
Construct a type with the properties of T except for those in type K.
ScimSchemaType.GROUP
string
ScimSchemaType.LIST_RESPONSE
string
ScimUser
object
9 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-scim-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 Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
Where this information came from

This is an independent, third-party profile of Lightdash SCIM 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.