DEdevflowinc
User

Update User Org Role

Changed on

Update a user's information for the org specified via header. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.

put/api/user

Request

  • Base URL
    https://api.trieve.ai
  • URL
    https://api.trieve.ai/api/user
  • Auth
    API key in header Authorization

Headers

TR-Organizationstring uuid required

The organization id to use for the request

Request body

roleinteger nullable

Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned.

scopesstring[] nullable

The scopes the user will have in the organization.

user_idstring uuid nullable

The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.

Response

Confirmation that the user's role was updated

Changes

  • e002d9858957Revision changes
    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became optional

  • 661f8d6f359bRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became required

    • warning

      removed the request property