PUT User

Overview

---

The following table contains important information about the PUT method in regards to updating a user.

PUT User
Method	PUT
URL or Endpoint	/api/projects/projectId/users
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "publicId": "string",
  "firstname": "string",
  "lastname": "string",
  "projectName": ["string"],
  "picture": "string",
  "email": "string",
  "isActive": true,
  "role": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isActive": true,
    "organizationId": 0
  },
  "isConfirmed": true,
  "defaultOrganizationId": 0
}

Information about the fields that appear in the request body are displayed in the table below.

Field Name	Type	Description
publicId	string	The public ID of the user
firstName	string	The first name of the user.
lastName	string	The last name of the user.
projectName	string	The name of the project.
picture	Image	The picture of the user.
email	string	The email of the user.
isActive	bool	Indicates whether the user is active.
role	Object	Returns the role as an object.
id	integer($int32)	The id of the
name	string	The name of the role.
description	string	The description of the role.
isActive	bool	Indicates whether the role is active.
organizationId	integer($int32)	The id of the organization.
isConfirmed	bool	Indicates whether the user is confirmed.
organizationId	string	The ID of the organization.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 6,
    "globalId": "55b8b8b7-584a-4b9b-949a-244c6347bcc6",
    "firstname": "Sejfi",
    "lastname": "Hoxha",
    "picture": null,
    "email": "sejfi@gjirafa.com",
    "isActive": true,
    "role": null,
    "isConfirmed": false
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the user
globalId	string	The global id of the user.
firstName	string	The first name of the user.
lastName	string	The last name of the user.
picture	Image	The picture of the user.
email	string	The email of the user.
isActive	bool	Indicates whether the user is active.
role	Object	Returns the role as an object.
isConfirmed	bool	Indicates whether the user is confirmed.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed