Revoke user access

auto_scribe.users.revoke_access() -> UserRevokeAccessResponse

post/v1/autoScribe/users/revoke-access

Deactivates a user's access to the system. The user will no longer be able to log in, create reports, or access studies. User data is preserved and can be reactivated later.

ParametersExpand Collapse

user_id: str

User ID to revoke access for. Format: usr_{32-hex-chars}

ReturnsExpand Collapse

class UserRevokeAccessResponse: …

Response for revoking user access in AutoScribe

success: bool

message: Optional[str]

Revoke user access

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.revoke_access(
    user_id="usr_1234567890abcdef1234567890abcdef",
)
print(response.success)

{
  "success": true,
  "message": "User access revoked successfully"
}

Returns Examples

{
  "success": true,
  "message": "User access revoked successfully"
}