Skip to main content
POST
/
api
/
v1
/
scim
/
v2
/
Users
Error
A valid request URL is required to generate request examples
{
  "schemas": [
    "<string>"
  ],
  "id": "<string>",
  "userName": "<string>",
  "meta": {
    "version": "<string>",
    "location": "<string>",
    "lastModified": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "resourceType": "<string>"
  },
  "name": {
    "familyName": "<string>",
    "givenName": "<string>"
  },
  "active": true,
  "emails": [
    {
      "value": "<string>",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "<string>",
      "display": "<string>",
      "type": "<string>",
      "primary": true
    }
  ],
  "urn:lightdash:params:scim:schemas:extension:2.0:User": {
    "role": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://lightdash-mintlify-505906c8.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

User to create

User to create

ā€‹
schemas
string[]
required
ā€‹
userName
string
required
ā€‹
urn:lightdash:params:scim:schemas:extension:2.0:User
object
ā€‹
name
object
ā€‹
active
boolean
ā€‹
emails
object[]
ā€‹
roles
object[]
ā€‹
meta
object
ā€‹
title
string
ā€‹
password
string

Response

Ok

ā€‹
schemas
string[]
required
ā€‹
id
string
required
ā€‹
userName
string
required
ā€‹
meta
object
ā€‹
name
object
ā€‹
active
boolean
ā€‹
emails
object[]
ā€‹
roles
object[]
ā€‹
urn:lightdash:params:scim:schemas:extension:2.0:User
object