Revoke user access

UserRevokeAccessResponse Viewer.Users.RevokeAccess(, )

POST/v1/viewer/users/revoke-access

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

ParametersExpand Collapse

UserRevokeAccessParams parameters

required string userID

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

ReturnsExpand Collapse

class UserRevokeAccessResponse:

Response for revoking user access in Viewer

required Boolean Success

string Message

Revoke user access

UserRevokeAccessParams parameters = new()
{
    UserID = "usr_1234567890abcdef1234567890abcdef"
};

var response = await client.Viewer.Users.RevokeAccess(parameters);

Console.WriteLine(response);

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

Returns Examples

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