## Invite

`auto_scribe.users.invite(UserInviteParams**kwargs)  -> UserInviteResponse`

**post** `/v1/autoScribe/users`

Creates a new user in the AutoScribe system and sends them an invitation email. The user will have the specified permissions including report creation and study management capabilities. NPI number is required for users who can create reports.

### Parameters

- `can_create_reports: bool`

- `can_manage_studies: bool`

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

  User's clinical or organizational role

  - `"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"`

- `email: str`

  User's email address for login and notifications

- `first_name: str`

  User's first name

- `has_dashboard_access: bool`

- `last_name: str`

  User's last name

- `level: Literal["admin", "member"]`

  - `"admin"`

  - `"member"`

- `middle_name: Optional[str]`

  User's middle name (optional)

- `npi_number: Optional[str]`

- `phone_number: Optional[str]`

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

- `suffix1: Optional[str]`

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

- `suffix2: Optional[str]`

  Additional name suffix (optional)

### Returns

- `class UserInviteResponse: …`

  Response for inviting a user to AutoScribe. Level is restricted to admin/member since owners cannot be invited via API.

  - `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

    - `"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

  - `email: str`

    User's email address for login and notifications

  - `first_name: str`

    User's first name

  - `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

    - `"dashboard"`

    - `"api"`

  - `last_login_at: Optional[datetime]`

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

  - `last_name: str`

    User's last name

  - `level: Literal["admin", "member"]`

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

    - `"admin"`

    - `"member"`

  - `user_id: str`

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

  - `middle_name: Optional[str]`

    User's middle name (optional)

  - `npi_number: Optional[str]`

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

  - `phone_number: Optional[str]`

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

  - `suffix1: Optional[str]`

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

  - `suffix2: Optional[str]`

    Additional name suffix (optional)

### Example

```python
import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.auto_scribe.users.invite(
    can_create_reports=True,
    can_manage_studies=True,
    clinic_role="Radiologist",
    email="dr.johnson@hospital.org",
    first_name="Sarah",
    has_dashboard_access=True,
    last_name="Johnson",
    level="member",
)
print(response.middle_name)
```