Patch a user

PATCH 
/v1/users/:user_email

This route allows you to patch a user's details. This can be used to update the user's role/s and team/s.

To learn more about users, roles, and teams, check out the documentation.

Request

Path Parameters

user_email stringrequired

The email address of the user you want to patch.

application/json

Body

rolesstring[]

The roles you want to assign to the user.


Possible values: >= 1

teamsstring[]

The names of the teams you want to assign the user to.

Responses

200

Updated successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

emailstring
firstNamestring
lastNamestring
picturestring
statusstring
idstring
typestring
providersstring[]
createdAtdate-time
updatedAtdate-time

orgs

object[]

Array [

idstringrequired

]

teamsstring[]

roles

object[]

Array [

namestringrequired

]

Example (from schema)

{
  "ok": true,
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "picture": "string",
  "status": "string",
  "id": "string",
  "type": "string",
  "providers": [
    "string"
  ],
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "orgs": [
    {
      "id": "string"
    }
  ],
  "teams": [
    "string"
  ],
  "roles": [
    {
      "name": "string"
    }
  ]
}