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

# Update the KODE OS role of a user

> Changes the role a user has in an app they already have access to.

> [!NOTE]
>
> This changes the role in the app only. The user's organization role stays the same. To change the organization role, use [Update a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/update-a-user.md).

> [!NOTE]
>
> The user must already have the app. If not, the request fails with `400` and the message "App not found". Wait until `assignmentStatus` is `SUCCEEDED` or `FAILED` before you change the role. A change while the assignment is still being set up is rejected.


## OpenAPI

````yaml /openapi/kode-api.yaml put /api/v1/users/{userId}/apps/{appId}
openapi: 3.1.0
info:
  title: KODE API
  version: 1.0.0
  summary: Programmatic access to KODE OS resources and operations.
  description: >
    Use the KODE API to work with buildings, data sources, connectors, devices,
    points, virtual devices,

    timeseries data, schedules, the ontology, templating, mass writes, spaces,
    space assignments, tenants, meters, users, actions,

    and AssetOps work orders.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.kodelabs.com/kodeos
    description: KODE API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: OAuth 2.0 discovery, token, and revocation endpoints.
  - name: Buildings
    description: Buildings and their areas.
  - name: Data sources
    description: Data sources connected to a building.
  - name: Devices
    description: Devices and their points.
  - name: Points
    description: Point queries and point writes.
  - name: Timeseries
    description: Current and historical point values.
  - name: Actions
    description: Actions exposed by building data sources.
  - name: Work orders
    description: AssetOps work orders, lookups, comments, and attachments.
  - name: Connectors
    description: KODE API connectors and the devices and points ingested through them.
  - name: Schedules
    description: Schedules discovered on building data sources.
  - name: Templating
    description: Apply ontology templates to groups of points.
  - name: Virtual devices
    description: Virtual devices that group points from other devices.
  - name: Ontology
    description: Canonical types, fields, units, and connections of the KODE ontology.
  - name: Users
    description: Users of the organization and their app access.
  - name: Mass write
    description: Write values to many points across buildings, and follow each run.
  - name: Spaces
    description: Levels and space units of a building, and the meters located in them.
  - name: Space assignments
    description: Assign tenants to leasable spaces of a building for a period.
  - name: Tenants
    description: Tenants of a building, the people or companies that lease its spaces.
  - name: Meters
    description: >-
      Meters of a building, their space assignments, parent and child links, and
      readings.
paths:
  /api/v1/users/{userId}/apps/{appId}:
    put:
      tags:
        - Users
      summary: Update the KODE OS role of a user
      description: Changes the role a user has in an app they already have access to.
      operationId: updateUserAppRole
      parameters:
        - name: appId
          in: path
          required: true
          schema:
            type: string
          description: Identifier of the app. Only `bms` is supported.
        - name: userId
          in: path
          required: true
          schema:
            type: string
          description: Identifier of the user.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAppRoleRequest'
        required: true
      responses:
        '204':
          description: The role was changed. The response has no body.
        '400':
          description: >-
            The `appId` is not `bms`, `role` is missing or blank or not a role
            of your `bms` app, or the user does not have the app ("App not
            found").
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: The service account is not allowed to set this role.
        '404':
          description: No user with this `userId` exists in your organization.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    UpdateAppRoleRequest:
      type: object
      required:
        - role
      properties:
        role:
          type: string
          pattern: \S
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    TooManyRequests:
      description: >-
        A rate-limit window is exhausted. Wait, then retry with increasing
        delays.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Paste an access token from [Create an access
        token](/products/kode-api/api-reference/authentication/create-an-access-token).
        Tokens expire, so request a new one if you receive `401`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.