Skip to content
Avara
Get started
API Reference
Auto Scribe
Users

Update a user

auto_scribe.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse
patch/v1/autoScribe/users/{userId}

Updates a user's profile information, permissions, and AutoScribe-specific settings. All fields are optional - only provided fields will be updated. Email cannot be changed via API. NPI number is required if enabling report creation capability.

ParametersExpand Collapse
user_id: str

Unique user identifier. Format: usr_{32-hex-chars}

can_create_reports: Optional[bool]
can_manage_studies: Optional[bool]
clinic_role: Optional[Literal["Radiologist", "Cardiologist", "Neurologist", 18 more]]
Accepts one of the following:
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Doctor"
"Surgeon"
"Physician"
"Physician Assistant"
"Nurse Practitioner"
"Registered Nurse"
"Patient Care Coordinator"
"Front Desk Operator"
"Imaging Technologist"
"PACS Administrator"
"Software Engineer"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Other"
first_name: Optional[str]

User's first name

minLength1
has_dashboard_access: Optional[bool]

Whether the user can access the dashboard interface. Required for admin users

last_name: Optional[str]

User's last name

minLength1
level: Optional[Literal["admin", "member"]]
Accepts one of the following:
"admin"
"member"
middle_name: Optional[str]
minLength1
npi_number: Optional[str]
minLength10
maxLength10
phone_number: Optional[str]
suffix1: Optional[str]
minLength1
suffix2: Optional[str]
minLength1
ReturnsExpand Collapse
class UserUpdateResponse: …

A user in the AutoScribe system with report creation permissions

can_create_reports: bool

Whether the user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: Literal["Radiologist", "Cardiologist", "Neurologist", 18 more]

User's clinical or organizational role

Accepts one of the following:
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Doctor"
"Surgeon"
"Physician"
"Physician Assistant"
"Nurse Practitioner"
"Registered Nurse"
"Patient Care Coordinator"
"Front Desk Operator"
"Imaging Technologist"
"PACS Administrator"
"Software Engineer"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Other"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User's email address for login and notifications

first_name: str

User's first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: Literal["dashboard", "api"]

How the user was invited - via dashboard UI or API

Accepts one of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user's last login, null if never logged in

formatdate-time
last_name: str

User's last name

minLength1
level: Literal["owner", "admin", "member"]

User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access

Accepts one of the following:
"owner"
"admin"
"member"
user_id: str

Unique user identifier. Format: usr_{32-hex-chars}

middle_name: Optional[str]

User's middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

User's phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
Update a user
import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
user = client.auto_scribe.users.update(
    user_id="usr_1234567890abcdef1234567890abcdef",
)
print(user.middle_name)
{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}
Returns Examples
{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}