Edit user

Request description

Endpoint: /users/:id/update
Method: PATCH

The following parameter must be passed through the URL:

• id: specifies the unique user identifier
  

Header

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <accessToken>"
}

Note: the <accessToken> is obtained as a result of the authentication

Payload

{
  "fullName": "mock-full-name",
  "groupId": "group-id",
  "userType": "REGULAR"
}

Payload structure

type EditUserPayloadType = {
  fullName?: string;
  groupId?: string;
  userType?: UserType;
};

type UserType = "ORGANIZATION_OWNER" | "ORGANIZATION_ADMIN" | "REGULAR";

Responses

Correct response

{
  // empty response
}

Wrong responses

{
  // empty body
}

Description: this error occurs when endpoint authorizers fail to validate the token sent in the request header.

{
  // empty body
}

Description: this error occurs when an user not found.

type EditUserResponseType = {
    errorType: Edit_USER_ERROR_TYPE,
      errorMessage?: string
}

enum Edit_USER_ERROR_TYPE {
  USER_NOT_FOUND= 'userNotFound'
  UNAUTHORIZED_RESOURCE = 'unauthorizedResource',
  INVALID_GROUP_ID = 'invalidGroupId',
  INVALID_ORGANIZATION_ROLE= 'invalidOrganizationRole'
}