Users

Update a user

This route allows you to update a user's details. This can be used to update the user's role/s and team/s.<br/><br/>To learn more about users, roles, and teams, check out the documentation.

patch/v1/users/{user_email}

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/users/{user_email}
  • Auth: API key in header Authorization

Path parameters

user_emailstring required

The email address of the user you want to operate on.

Request body

rolesstring[]

The roles you want to assign to the user.

teamsstring[]

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

Response

Updated successfully.

okunknown required
emailstring
firstNamestring
lastNamestring
picturestring
statusstring
idstring
typestring
providersstring[]
createdAtstring date-time
updatedAtstring date-time
teamsstring[]
termsAcceptedboolean
managedByScimboolean
companyIdstring nullable
companyRolestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.