Skip to main content
Browse Documentation

Suspend a user

Created by Alex Pop on 24 Nov 2020

A user can be suspended using the following call:

suspendUser(userId: string): Promise<void>

Remarks

The userId can be username, email address or a GUID identifier.

If the user is not found then an exception with a 404 Not found is thrown.
If there are no permissions to suspend a user then an exception with a 403 Forbidden status is thrown.

Example

client.security.users.suspendUser("4b262379-5bbe-421e-a429-f6e2ab5a849b")
    .then( result => {
        console.log('API call was successful');
    })
    .catch(error => {
        console.log('API call error: ', error);        
    });