> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.omni.co/feedback

```json
{
  "path": "/api/users/update-user",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# Update user

> Updates the specified user by setting the values of the parameters provided and leaving all other properties of the user unchanged.



## OpenAPI

````yaml /api/openapi.yaml put /scim/v2/users/{userId}
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: AI
    description: AI-powered query generation
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Labels
    description: >
      Manage labels in an organization. Labels can be applied to documents and
      folders to help organize and categorize content.


      **Label types:**

      - **Basic labels**: Can be created and managed by any user

      - **Verified labels**: Indicate curated or officially sanctioned content.
      Admin-only.

      - **Homepage labels**: Appear on the organization homepage. Admin-only.
  - name: Folders
    description: Create and organize content folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /scim/v2/users/{userId}:
    put:
      tags:
        - Users
      summary: Update user
      description: >-
        Updates the specified user by setting the values of the parameters
        provided and leaving all other properties of the user unchanged.
      operationId: updateUser
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
          description: The ID of the user to be updated
          example: 9e8719d9-276a-4964-9395-a493189a247c
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - userName
              properties:
                displayName:
                  type: string
                  description: The user's display name
                  example: Blob Ross
                userName:
                  type: string
                  format: email
                  description: >-
                    The user's email address. Set this to a new value to update
                    the email for an existing user. The new email must be unique
                    within your organization.
                  example: blob.ross@blobsrus.co
                urn:omni:params:1.0:UserAttribute:
                  type: object
                  description: >
                    [User attributes](/administration/users/attributes) as
                    key/value pairs, where keys map to the IDs of user
                    attributes defined in Omni. This is the **Reference** column
                    in the **User attributes** page.
                  example:
                    good_blob: 'yes'
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
              example:
                active: true
                displayName: Blob Ross
                emails:
                  - primary: true
                    value: blob.ross@blobsrus.co
                groups: []
                id: 9e8719d9-276a-4964-9395-a493189a247c
                meta:
                  created: '2024-12-03T23:13:14.109Z'
                  lastModified: '2024-12-03T23:13:14.109Z'
                  resourceType: User
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:User
                userName: blob.ross@blobsrus.co
                urn:omni:params:1.0:UserAttribute:
                  good_blob: 'yes'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - orgApiKey: []
components:
  schemas:
    ScimUser:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the user
        userName:
          type: string
          description: The user's email address
        displayName:
          type: string
          description: The user's display name
        active:
          type: boolean
          description: Whether the user is active
        emails:
          type: array
          description: The user's email addresses
          items:
            type: object
            properties:
              primary:
                type: boolean
                description: Whether this is the user's primary email
              value:
                type: string
                description: The email address
        groups:
          type: array
          description: User groups that the user belongs to
          items:
            type: object
            properties:
              display:
                type: string
                description: The group's display name
              value:
                type: string
                description: The group's unique identifier
        meta:
          type: object
          properties:
            resourceType:
              type: string
              example: User
              description: The resource type. This will be `User`.
            created:
              type: string
              format: date-time
              description: The time the user was created
            lastModified:
              type: string
              format: date-time
              description: The time the user was last updated
        schemas:
          type: array
          items:
            type: string
          description: >
            SCIM information about the type of schemas used in the API. For
            example, `urn:ietf:params:scim:schemas:core:2.0:User`
        urn:omni:params:1.0:UserAttribute:
          type: object
          description: >
            [User attributes](/administration/users/attributes) as key/value
            pairs, where keys map to the IDs of user attributes defined in Omni.
            This is the **Reference** column in the **User attributes** page.
        urn:omni:params:scim:schemas:extension:user:2.0:
          type: object
          description: Omni SCIM extension schema containing additional user metadata
          properties:
            lastLogin:
              type: string
              format: date-time
              nullable: true
              description: >-
                The timestamp of the user's last login. Will be `null` if the
                user has never logged in.
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#personal-access-tokens-pat).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````