Skip to content
Get started

Revoke user access

UserRevokeAccessResponse autoScribe().users().revokeAccess(UserRevokeAccessParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
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
UserRevokeAccessParams params
String userId

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

ReturnsExpand Collapse
class UserRevokeAccessResponse:

Response for revoking user access in AutoScribe

boolean success
Optional<String> message
Revoke user access
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.users.UserRevokeAccessParams;
import com.avara.models.autoscribe.users.UserRevokeAccessResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        UserRevokeAccessParams params = UserRevokeAccessParams.builder()
            .userId("usr_1234567890abcdef1234567890abcdef")
            .build();
        UserRevokeAccessResponse response = client.autoScribe().users().revokeAccess(params);
    }
}
{
  "success": true,
  "message": "User access revoked successfully"
}
Returns Examples
{
  "success": true,
  "message": "User access revoked successfully"
}