Lightdash User attributes API

openapi: 3.2.0
info:
  title: Lightdash User attributes 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: User Attributes
paths:
  /api/v2/orgs/{orgUuid}/code/userAttributes:
    get:
      operationId: GetCodeUserAttributes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserAttributeAsCodeListResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - User Attributes
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      summary: Get code user attributes
      x-summary-source: derived
    post:
      operationId: UpsertCodeUserAttribute
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserAttributeAsCodeUpsertResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - User Attributes
      security: []
      parameters:
      - in: path
        name: orgUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAttributeAsCode'
      summary: Upsert code user attribute
      x-summary-source: derived
  /api/v1/org/attributes:
    get:
      operationId: getUserAttributes
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserAttributesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get all user attributes
      summary: List user attributes
      tags:
      - User Attributes
      security: []
      parameters: []
    post:
      operationId: createUserAttribute
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateUserAttributeResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Creates new user attribute
      summary: Create user attribute
      tags:
      - User Attributes
      security: []
      parameters: []
      requestBody:
        description: the user attribute to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserAttribute'
              description: the user attribute to create
  /api/v1/org/attributes/{userAttributeUuid}:
    put:
      operationId: updateUserAttribute
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateUserAttributeResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Updates a user attribute
      summary: Update user attribute
      tags:
      - User Attributes
      security: []
      parameters:
      - description: the UUID for the group to add the user to
        in: path
        name: userAttributeUuid
        required: true
        schema:
          type: string
      requestBody:
        description: the user attribute to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserAttribute'
              description: the user attribute to update
    delete:
      operationId: removeUserAttribute
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Remove a user attribute
      summary: Delete user attribute
      tags:
      - User Attributes
      security: []
      parameters:
      - description: the user attribute UUID to remove
        in: path
        name: userAttributeUuid
        required: true
        schema:
          type: string
components:
  schemas:
    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.'
    CreateUserAttributeValue:
      properties:
        value:
          type: string
          deprecated: true
        values:
          items:
            type: string
          type: array
        userUuid:
          type: string
      required:
      - userUuid
      type: object
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
      required:
      - status
      type: object
    PromotionAction.NO_CHANGES:
      enum:
      - no changes
      type: string
    PromotionAction.UPDATE:
      enum:
      - update
      type: string
    PromotionAction.CREATE:
      enum:
      - create
      type: string
    UserAttributeValue:
      properties:
        value:
          type: string
          deprecated: true
        values:
          items:
            type: string
          type: array
        email:
          type: string
        userUuid:
          type: string
      required:
      - value
      - values
      - email
      - userUuid
      type: object
    CreateUserAttribute:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/CreateGroupAttributeValue'
          type: array
        users:
          items:
            $ref: '#/components/schemas/CreateUserAttributeValue'
          type: array
        attributeDefault:
          anyOf:
          - items:
              type: string
            type: array
          - type: string
          deprecated: true
        attributeDefaults:
          items:
            type: string
          type:
          - array
          - 'null'
          description: Canonical default value(s). null/empty means no default.
        description:
          type: string
        name:
          type: string
      required:
      - groups
      - users
      - name
      type: object
    UserAttributeAsCode:
      properties:
        groups:
          items:
            properties:
              values:
                items:
                  type: string
                type: array
              name:
                type: string
            required:
            - values
            - name
            type: object
          type: array
        users:
          items:
            properties:
              values:
                items:
                  type: string
                type: array
              email:
                type: string
            required:
            - values
            - email
            type: object
          type: array
        attributeDefaults:
          items:
            type: string
          type:
          - array
          - 'null'
        description:
          type:
          - string
          - 'null'
        name:
          type: string
        version:
          type: number
          enum:
          - 1
      required:
      - groups
      - users
      - attributeDefaults
      - description
      - name
      - version
      type: object
    ApiCreateUserAttributeResponse:
      properties:
        results:
          $ref: '#/components/schemas/UserAttribute'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    CreateGroupAttributeValue:
      properties:
        value:
          type: string
          deprecated: true
        values:
          items:
            type: string
          type: array
        groupUuid:
          type: string
      required:
      - groupUuid
      type: object
    Record_never.never_:
      properties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    ApiContentAsCodeUpsertResponse:
      properties:
        results:
          allOf:
          - properties:
              action:
                $ref: '#/components/schemas/ContentAsCodeUpsertAction'
            required:
            - action
            type: object
          - $ref: '#/components/schemas/Record_never.never_'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ApiUserAttributesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/UserAttribute'
          type: array
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ContentAsCodeUpsertAction:
      anyOf:
      - $ref: '#/components/schemas/PromotionAction.CREATE'
      - $ref: '#/components/schemas/PromotionAction.UPDATE'
      - $ref: '#/components/schemas/PromotionAction.NO_CHANGES'
    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'
    ApiContentAsCodeListResponse__userAttributes-UserAttributeAsCode-Array__:
      properties:
        results:
          properties:
            userAttributes:
              items:
                $ref: '#/components/schemas/UserAttributeAsCode'
              type: array
          required:
          - userAttributes
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    UserAttribute:
      properties:
        attributeDefault:
          type:
          - string
          - 'null'
          deprecated: true
        attributeDefaults:
          items:
            type: string
          type:
          - array
          - 'null'
        groups:
          items:
            $ref: '#/components/schemas/GroupAttributeValue'
          type: array
        users:
          items:
            $ref: '#/components/schemas/UserAttributeValue'
          type: array
        description:
          type: string
        organizationUuid:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        uuid:
          type: string
      required:
      - attributeDefault
      - attributeDefaults
      - groups
      - users
      - organizationUuid
      - name
      - createdAt
      - uuid
      type: object
    GroupAttributeValue:
      properties:
        value:
          type: string
          deprecated: true
        values:
          items:
            type: string
          type: array
        groupUuid:
          type: string
      required:
      - value
      - values
      - groupUuid
      type: object
    ApiUserAttributeAsCodeListResponse:
      $ref: '#/components/schemas/ApiContentAsCodeListResponse__userAttributes-UserAttributeAsCode-Array__'
    ApiUserAttributeAsCodeUpsertResponse:
      $ref: '#/components/schemas/ApiContentAsCodeUpsertResponse'
  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)