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. The authentication flow you have to follow depends on the access mode, see Access modes.

Access modes

This endpoint accepts two kinds of access token. The meaning of :id and the request body depend on which one you use:

Platform user

Payload

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

Payload structure

type EditUserPayloadType = {
  fullName?: string;   // Not empty when sent
  groupId?: string;    // Id of an existing group of your organization
  userType?: UserType; // User role in the organization
};

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

All fields are optional. Only the fields you send are updated. A request with an empty body {} is accepted and does not change the user.

Role rules:

• Only an Organization Owner can assign the ORGANIZATION_OWNER role, or change the role of a user who is an Organization Owner.
• An organization must always keep at least one Organization Owner.

Dictation user

Updates a user of the corporate dictation server of the organization associated with your credentials.

Payload

{
  "login": "jperez2",
  "fullName": "Juan Perez Gomez",
  "email": "jperez@hospital.com",
  "specialtyCode": "1",
  "organization": "Hospital X"
}

Payload structure

type EditDictationUserPayloadType = {
  login?: string; // Only to rename the user. Defaults to the login in the URL
  fullName: string; // Required
  email: string; // Required
  specialtyCode: string; // Required
  organization?: string; // Free-text organization label
};

Partial updates are not supported

Renaming a user

Send the current login in the URL and the new one in the login field of the body. If login is omitted, the user keeps its current login.

Field rules

See Invite user for details about specialtyCode.

The license type of the user is managed by the platform and is not affected by this request. Any additional field sent in the payload is ignored.

Known limitation

Responses

Correct response

{
  "message": "User updated successfully"
}

{
  "message": "User updated successfully",
  "login": "jperez2"
}

Wrong responses

{
  "message": "Unauthorized"
}

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

{
  "errorType": "InvalidParameters",
  "errorMessage": "User not found",
  "message": "User not found",
  "details": [
    /* validation detail */
  ]
}

Description: there is no user with the identifier sent in the URL.

type EditUserResponseType = {
  errorType: Edit_USER_ERROR_TYPE;
  errorMessage: string;
  message?: string;    // Present on validation errors
  details?: object[];  // Present on validation errors
};

enum Edit_USER_ERROR_TYPE {
  INVALID_REQUEST_FORMAT = "invalidRequestFormat",
  INVALID_GROUP_ID = "invalidGroupId",
  UNAUTHORIZED_RESOURCE = "unauthorizedResource",
  NOT_ALLOWED_RESOURCE = "notAllowedResource",
}

{
  "errorType": "notAllowedResource",
  "errorMessage": "Unauthorized",
  "message": "Unauthorized"
}

{
  "errorType": "invalidRequestFormat",
  "errorMessage": "Specialty code is required",
  "message": "Specialty code is required",
  "details": [
    /* validation detail */
  ]
}

Description: errorMessage identifies the first field that failed. Possible values:

{
  "message": "Forbidden"
}

{
  "message": "Dictation server rejected the operation"
}

{
  "message": "There is no user with that login in the dictation server"
}

{
  "message": "Tenant not found"
}

{
  "message": "Dictation server unavailable"
}

Description: the dictation server could not complete the request. Also returned when the speciality code is not valid.

{
  "message": "Dictation server did not respond in time"
}

Description: the dictation server did not answer within the allowed time.