Homepage / Doc / Unlock User

Unlock User

The UnlockUser method can be utilized to “unlock” a user giving them access to the Checkbox Application again. It will not change the access that they had before they were locked. This method will return true if it was successful at unlocking a user. If the user was already unlocked, it will also return true.

class Test
{
    private static void Main()
    {
        dynamic client = new UserManagementServiceClient();

        dynamic unlockUserResponse = client.UnlockUser(authToken, "Test-UserName");

        if (!unlockUserResponse.CallSuccess) {
            Console.WriteLine(unlockUserResponse.FailureMessage);
            return;
        }

        dynamic unlockUserData = unlockUserResponse.ResultData;

        //If this is true, then the unlock was successful
        Console.WriteLine(unlockUserData ? "Unlocking of user was successful" : "Unlocking of user was not successful");

        //Always close the client
        client.Close();
    }
}

 

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
uniqueIdentifier string Username of the user that you wish to unlock
November 15, 2016